README.md in jekyll_push-0.1.0 vs README.md in jekyll_push-0.1.1
- old
+ new
@@ -1,27 +1,58 @@
# JekyllPush
-Jekyll gem plugin to push a compiled site to a GitHub branch. Works locally or on Travis CI if you add an access token.
+[](https://travis-ci.org/mnyrop/jekyll_push) [](https://badge.fury.io/rb/jekyll_push) [](https://badge.fury.io/rb/jekyll_push) [](https://codeclimate.com/github/mnyrop/jekyll_push/maintainability) [](https://codeclimate.com/github/mnyrop/jekyll_push/test_coverage) [](https://www.rubydoc.info/github/mnyrop/jekyll_push/) 
+
+__Jekyll gem plugin to push a compiled Jekyll site to a GitHub branch.__ Works locally or on Travis CI if you add an access token to your Travis build. Great for keeping archived copies or getting to use Jekyll Plugins and still host on GitHub pages.
+
+
+
+
## Installation
-Add this line to your application's Gemfile:
+Add `jekyll_push` to your Jekyll sites's Gemfile within the `:jekyll_plugins` group:
```ruby
-gem 'jekyll_push'
+group :jekyll_plugins do
+ gem 'jekyll_push'
+end
```
And then execute:
$ bundle
+
+Make sure you also add `jekyll_push` as a `plugin` to your `_config.yml` file:
+```yml
+plugins:
+ - jekyll_push
+```
-Or install it yourself as:
-
- $ gem install jekyll_push
-
## Usage
`$ jekyll push <branch_name>` or `$ bundle exec jekyll push <branch_name>`
+## Configuration
+
+### For GitHub pages
+
+If you run `jekyll push gh-pages` to use __GitHub pages publishing__, `JekyllPush` will look for a `repo_name` variable in your `_config.yml` file and try to construct a `baseurl` from it.
+
+For example, if you have a repository named `my_site` just add:
+
+```yaml
+repo_name: my_site
+```
+
+to your `_config.yml` file and `JekyllPush` will rebuild your site using `/my_site` as the `baseurl` before pushing it to the `gh-pages` branch. This lets you use `JekyllPush` for multiple branches and publish targets, with differing (base)url patterns.
+
+### When run locally
+
+[ TO DO ]
+
+### When run via Travis-CI
+
+[ TO DO ]
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mnyrop/jekyll_push. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.