README.md in jgd-1.4 vs README.md in jgd-1.5
- old
+ new
@@ -1,7 +1,18 @@
[](http://badge.fury.io/rb/jgd)
+# What is jgd ?
+
+If you use some plugins with you Jekyll blog, chances are you can not
+have you blog generated by GitHub.
+
+This is where jekyll-github-deploy (a.k.a. jgd) comes in: it will
+automatically build your Jekyll blog and push it to your gh-pages
+branch.
+
+# Installing
+
It is assumed that your blog is in the home directory of your repo.
Install it first:
```bash
@@ -14,12 +25,23 @@
jgd
```
Now your site is deployed to `gh-pages` branch of your repo. Done.
+# Production variables
+
+If you need to have different values for your deployed blog, just add a
+`_config-deploy.yml` file in your project's root and you're set. Values
+re-defined in `_config-deploy.yml` will override those defined in
+`_config.yml`.
+
+Typical usage includes changing site `url`, disable disqus or ga in
+development...., you name it.
+
+# Deploying with Travis
+
This is how I configure [my Jekyll blog](https://github.com/yegor256/blog)
-to be deployed automatically by
-[travis-ci](http://www.travis-ci.org):
+to be deployed automatically by [travis-ci](http://www.travis-ci.org):
```yaml
branches:
only:
- master