Skip to content

Commit

Permalink
updated readme doc
Browse files Browse the repository at this point in the history
  • Loading branch information
rkumar committed Jun 21, 2010
1 parent 66d0167 commit fd4e9ae
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.rdoc
Expand Up @@ -3,6 +3,8 @@
A tiny wrapper over ruby's awesome OptionParser (standard) which gives easy facility of subcommands.
It has a similar interface to git and prints subcommands summary as well.

Options parsers are lazy-loaded thanks to a suggestion and sample code by Robert Klemme on ruby-forum.org.

== Features:

1. subcommands using all of OptionParser's features
Expand Down Expand Up @@ -96,6 +98,15 @@ Assuming a program "prog" with subcommands "del" and "add"

Or, copy into your lib directory and require (see source for sample usage)

== Testing

This comes with a bunch of test cases, that I think cover all cases including printing help
for aliases.

make test

You should have no errors. The test cases are in the **tests** folder.

== Note on Patches/Pull Requests

* Fork the project.
Expand Down

0 comments on commit fd4e9ae

Please sign in to comment.