README.md in gemstat-0.2.2 vs README.md in gemstat-0.3.0
- old
+ new
@@ -1,12 +1,60 @@
-# gemstat
-gemstat is a gem usage analyzer which tells you the number of gems used and even similarlity of each gems
+gemstat is a gem usage analyzer which tells you the number of gems used and even similarlity of each gems.
+# Usage
+
```
-# install
-gem install gemstat
+# Install
+$ gem install gemstat
-# how-to-use
-find `pwd` | grep Gemfile$ | ruby gemstat.rb
+# Show a list of gems which are similar to a given gem
+$ gemstat look_like ../sinatra/Gemfile
+aldebaran (0.5pt)
+annyong (0.333pt)
+aframe-switch (0.333pt)
+acceptable (0.333pt)
+angularjs_json_middleware (0.333pt)
+adsf (0.333pt)
+anupom-anobik (0.333pt)
+any_view (0.333pt)
+arthurgeek-nyane (0.333pt)
+aslakhellesoy-bcat (0.333pt)
+
+# Show a list of gems which are suggested for a given gem
+$ gemstat suggest_for activerecord
+rspec (0.667pt)
+activerecord (0.667pt)
+tzinfo (0.333pt)
+
+# Show a list of gems a given gem is required by
+$ gemstat also_required actionview
+aaf-lipstick
+action_widget
+actionmailer
+actionpack
+actionview-helpers-auto_tag_helper
+actionview-pathfinder
+actionview-rev_manifest
+activerecord-userstamp
+augit
+aws_upload
+
+# Show a list of gems a given gem dependents on
+$ gemstat dependency actionview
+activesupport
+builder
+erubis
+rails-html-sanitizer
+rails-dom-testing
+actionpack
+activemodel
```
-Cheers!
+### license
+
+MIT
+
+### TODO
+
+- Modify `update` subcommand to allow incremental update
+- Update README.md and gemstat.gemspec with better descriptions
+- Windows support (Now only Mac and Linux is supported)