README.md in compare_linker-1.2.1 vs README.md in compare_linker-1.3.0
- old
+ new
@@ -1,13 +1,39 @@
-# Compare Linker [![Build Status][travis-badge]][travis-link] [![Gem Version][gem-badge]][gem-link]
+# Compare Linker
+[![Travis Status](https://img.shields.io/travis/masutaka/compare_linker.svg?maxAge=2592000)][travisci]
+[![License](https://img.shields.io/github/license/masutaka/compare_linker.svg?maxAge=2592000?style=flat-square)][license]
+[![Gem](https://img.shields.io/gem/v/compare_linker.svg?maxAge=2592000?style=flat-square)][gem-link]
+
+[travisci]: https://travis-ci.org/masutaka/compare_linker
+[license]: https://github.com/masutaka/compare_linker/blob/master/LICENSE.txt
+[gem-link]: http://badge.fury.io/rb/compare_linker
+
+## Description
+
Create GitHub's compare view URLs for pull request from diff of `Gemfile.lock` (and post comment to pull request).
![screen shot 2014-01-27 at 2 25 14 am](https://f.cloud.github.com/assets/10515/2004469/de374152-86ae-11e3-84a0-19e2ef40b959.png)
[GitHub Compare View](https://github.com/blog/612-introducing-github-compare-view) rocks.But [diff of Gemfile.lock](https://github.com/kyanny/compare_linker_demo/pull/14/files) sucks. So I made Compare Linker.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'compare_linker'
+```
+
+And then execute:
+
+ $ bundle
+
+Or install it yourself as:
+
+ $ gem install compare_linker
+
## Usage
```ruby
require 'compare_linker'
@@ -17,15 +43,18 @@
compare_linker.formatter = CompareLinker::Formatter::Markdown.new
comment = compare_linker.make_compare_links.to_a.join("\n")
compare_linker.add_comment('masutaka/compare_linker', '17', comment)
```
-## Rack app for listening GitHub Webhook
+## Development
-There's rack application for Compare Linker with GitHub's Webhook.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-https://github.com/kyanny/compare_linker_rack_app
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-[travis-badge]: https://travis-ci.org/masutaka/compare_linker.svg?branch=master
-[travis-link]: https://travis-ci.org/masutaka/compare_linker
-[gem-badge]: https://badge.fury.io/rb/compare_linker.svg
-[gem-link]: http://badge.fury.io/rb/compare_linker
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/masutaka/compare_linker. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).