README.md in jgd-1.11 vs README.md in jgd-1.12

- old
+ new

@@ -1,43 +1,42 @@ -[![Managed by Zerocracy](http://www.zerocracy.com/badge.svg)](http://www.zerocracy.com) +<img src="/logo.svg" width="64px" height="64px"/> + +[![Managed by Zerocracy](https://www.0crat.com/badge/C3RFVLU72.svg)](https://www.0crat.com/p/C3RFVLU72) [![DevOps By Rultor.com](http://www.rultor.com/b/yegor256/jekyll-github-deploy)](http://www.rultor.com/p/yegor256/jekyll-github-deploy) -[![We recommend RubyMine](http://img.teamed.io/rubymine-recommend.svg)](https://www.jetbrains.com/ruby/) +[![We recommend RubyMine](https://www.elegantobjects.org/rubymine.svg)](https://www.jetbrains.com/ruby/) [![Build Status](https://travis-ci.org/yegor256/jekyll-github-deploy.svg)](https://travis-ci.org/yegor256/jekyll-github-deploy) [![Gem Version](https://badge.fury.io/rb/jgd.svg)](http://badge.fury.io/rb/jgd) -[![Dependency Status](https://gemnasium.com/yegor256/jekyll-github-deploy.svg)](https://gemnasium.com/yegor256/jekyll-github-deploy) -[![Code Climate](http://img.shields.io/codeclimate/github/yegor256/jekyll-github-deploy.svg)](https://codeclimate.com/github/yegor256/jekyll-github-deploy) +[![Hits-of-Code](https://hitsofcode.com/github/yegor256/jekyll-github-deploy)](https://hitsofcode.com/view/github/yegor256/jekyll-github-deploy) +[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/yegor256/jekyll-github-deploy/blob/master/LICENSE.txt) -## What is jgd ? - -If you use some plugins with your Jekyll blog, chances are you can not -have your blog generated by GitHub. - +If you use some plugins with your [Jekyll](https://jekyllrb.com/) blog, chances are you can not +have your blog generated by [GitHub Pages](https://pages.github.com/). +First of all, because they [do not allow](https://help.github.com/en/articles/adding-jekyll-plugins-to-a-github-pages-site) +custom plugins. 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. +branch. You may want to read this blog post before you start +using this tool: +[_Deploy Jekyll to GitHub Pages_](https://www.yegor256.com/2014/06/24/jekyll-github-deploy.html). -## Installing - It is assumed that your blog is in the home directory of your repo. Install it first: ```bash -gem install jgd +$ gem install jgd ``` Run it locally: ```bash -jgd +$ jgd ``` Now your site is deployed to `gh-pages` branch of your repo. Done. -## Command Line Options - Below is a list of all command line options. | Option | Description | | -------- | ----------- | | `-u` or `--url` | The GitHub URL. Defaults to th URL of your current project. | @@ -45,12 +44,10 @@ | `-r` or `--branch-from` | The source branch. Defaults to `master`. | | `-c` or `--config` | Name of the optional deploy config file. See [Production variables](#production-variables) below for more information. | | `-d` or `--drafts` | Adds the `--drafts` option to Jekyll so that it will build draft posts. | | `-h` or `--help` | Displays a list of all options. | -## 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`. @@ -101,12 +98,13 @@ - jgd -u git@github.com:yegor256/blog.git ``` Read also [this article](http://www.yegor256.com/2014/06/24/jekyll-github-deploy.html). -# Building locally +## Building locally + In order to build a package locally run below commands. ```bash gem build jgd.gemspec gem install jgd-<version>.gem -``` \ No newline at end of file +```