Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add description & installation instructions

  • Loading branch information...
commit 606d10836987a4b0a3697ef621d51e533761ef36 1 parent 83373bf
Cory Flanigan seeflanigan authored Brian Donovan committed
Showing with 15 additions and 2 deletions.
  1. +15 −2 README.rdoc
17 README.rdoc
View
@@ -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[http://github.com/jimweirich/rake] build tool. The syntax is Rake-like, so it should be familiar to most Rake users.
+
+== Installation
+
+$ gem install thor
+
+or
+
+$ gem install wycats-thor -s http://gems.github.com
+
+== 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
-See MIT LICENSE.
+Released under the MIT License. See the LICENSE file for further details.
Please sign in to comment.
Something went wrong with that request. Please try again.