README.md in annotate_gem-0.0.8 vs README.md in annotate_gem-0.0.10
- old
+ new
@@ -1,8 +1,11 @@
+[](https://travis-ci.org/ivantsepp/annotate_gem)
+[](https://badge.fury.io/rb/annotate_gem)
+
# AnnotateGem
-`annotate_gem` is command line tool that will add useful comments to your Gemfile. For each gem, `annotate_gem` will create a comment with the gem's description and the gem's website. For example, a Gemfile containing the following
+`annotate-gem` is command line tool that will add useful comments to your Gemfile. For each gem, `annotate-gem` will create a comment with the gem's description and the gem's website. For example, a Gemfile containing the following
```ruby
gem "rails"
gem "nokogiri"
gem "brakeman"
@@ -17,38 +20,38 @@
gem "nokogiri"
# Security vulnerability scanner for Ruby on Rails. (http://brakemanscanner.org)
gem "brakeman"
```
-The motivation for `annotate_gem` is that developers often open a Gemfile and not know what many of the listed gems are actually for. It's hard to track down which gem is providing which functionality. This is a common problem since many gem names do not reflect the actual feature.
+The motivation for `annotate-gem` is that developers often open a Gemfile and not know what many of the listed gems are actually for. It's hard to track down which gem is providing which functionality. This is a common problem since many gem names do not reflect the actual feature.
-If you do _not_ want to install the gem, you can also visit <https://annotate_gem.herokuapp.com/> which is a web interface for `annotate_gem`.
+If you do _not_ want to install the gem, you can also visit <https://annotate-gem.herokuapp.com/> which is a web interface for `annotate-gem`.
## Installation
```
$ gem install annotate_gem
```
## Usage
-Running `annotate_gem` itself will add comments to the current directory's `Gemfile`.
+Running `annotate-gem` itself will add comments to the current directory's `Gemfile`.
```
$ cat Gemfile
source 'https://rubygems.org'
gem "pry"
-$ annotate_gem
+$ annotate-gem
$ cat Gemfile
source 'https://rubygems.org'
# An IRB alternative and runtime developer console (http://pryrepl.org)
gem "pry"
```
-`annotate_gem` has several options and you can see them via `annotate_gem -h`. `annotate_gem` also works with specifying a single gem name:
+`annotate-gem` has several options and you can see them via `annotate-gem -h`. `annotate-gem` also works with specifying a single gem name:
```
-$ annotate_gem aasm
+$ annotate-gem aasm
State machine mixin for Ruby objects (https://github.com/aasm/aasm)
```
## Contributing