README.md in grub-0.0.6 vs README.md in grub-0.0.7
- old
+ new
@@ -1,31 +1,66 @@
# Grub
-TODO: Write a gem description
+`grub` is command line tool that will add useful comments to your Gemfile. For each gem, `grub` will create a comment with the gem's description and the gem's website. For example, a Gemfile containing the following
-## Installation
+```ruby
+gem "rails"
+gem "nokogiri"
+gem "brakeman"
+```
-Add this line to your application's Gemfile:
+will be converted into something that is more descriptive and is self-documenting:
```ruby
-gem 'grub'
+# Full-stack web application framework. (http://www.rubyonrails.org)
+gem "rails"
+# Nokogiri (鋸) is an HTML, XML, SAX, and Reader parser (http://nokogiri.org)
+gem "nokogiri"
+# Security vulnerability scanner for Ruby on Rails. (http://brakemanscanner.org)
+gem "brakeman"
```
-And then execute:
+The motivation for `grub` 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.
- $ bundle
+## Installation
-Or install it yourself as:
+```
+$ gem install grub
+```
- $ gem install grub
-
## Usage
-TODO: Write usage instructions here
+Running `grub` itself will add comments to the current directory's `Gemfile`.
+```
+$ cat Gemfile
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grub.gemspec
+gemspec
+
+gem "pry"
+$ grub
+$ cat Gemfile
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grub.gemspec
+gemspec
+
+# An IRB alternative and runtime developer console (http://pryrepl.org)
+gem "pry"
+```
+
+`grub` has several options and you can see them via `grub -h`. `grub` also works with specifying a single gem name:
+
+```
+$ grub aasm
+State machine mixin for Ruby objects (https://github.com/aasm/aasm)
+```
+
## Contributing
-1. Fork it ( https://github.com/[my-github-username]/grub/fork )
+1. Fork it ( https://github.com/ivantsepp/grub/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request