Browse files

Add description & installation instructions

  • Loading branch information...
1 parent 83373bf commit 606d10836987a4b0a3697ef621d51e533761ef36 @seeflanigan seeflanigan committed with Brian Donovan Jul 22, 2010
Showing with 15 additions and 2 deletions.
  1. +15 −2 README.rdoc
@@ -1,5 +1,18 @@
-= thor
+= thor
+== Description
+Thor is a simple and efficient tool for building self-documenting command line utilities. It removes the pain of parsing command line options, writing "USAGE:" banners, and can also be used as an alternative to the Rake[] build tool. The syntax is Rake-like, so it should be familiar to most Rake users.
+== Installation
+$ gem install thor
+$ gem install wycats-thor -s
+== Usage
Map options to a class. Simply create a class with the appropriate annotations
and have options automatically map to functions and parameters.
@@ -294,4 +307,4 @@ options Thor offers.
== License
+Released under the MIT License. See the LICENSE file for further details.

0 comments on commit 606d108

Please sign in to comment.