Permalink
Browse files

Update installation instructions; link to LICENSE

  • Loading branch information...
1 parent 2aacc31 commit 23b32a2078f3ee5bce0da0dbcd0245e2a5ab019e @sferik sferik committed May 20, 2011
Showing with 20 additions and 15 deletions.
  1. +1 −1 LICENSE → LICENSE.md
  2. +19 −14 README.md
View
@@ -17,4 +17,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
View
@@ -1,21 +1,26 @@
-# Thor
+Thor
+====
-## Description
+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][rake]
+build tool. The syntax is Rake-like, so it should be familiar to most Rake
+users.
-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](https://github.com/jimweirich/rake) build tool. The syntax is Rake-like, so it should be familiar to most Rake users.
+[rake]: https://github.com/jimweirich/rake
-## Installation
-
-$ gem install thor
-
-or
-
-$ gem install wycats-thor -s http://gems.github.com
-
-## Usage and documentation
+Installation
+------------
+ gem install thor
+Usage and documentation
+-----------------------
Please see [the wiki](https://github.com/wycats/thor/wiki) for basic usage and other documentation on using Thor.
-## License
+License
+-------
+Released under the MIT License. See the [LICENSE][license] file for further details.
-Released under the MIT License. See the LICENSE file for further details.
+[license]: https://github.com/wycats/thor/blob/master/LICENSE.md

0 comments on commit 23b32a2

Please sign in to comment.