README.rdoc in afurmanov-clicase-0.1.6 vs README.rdoc in afurmanov-clicase-0.1.7
- old
+ new
@@ -1,16 +1,26 @@
-= CliCase - Macros for testing Ruby command line apps with Shoulda or Test::Unit
+= CliCase - Gem extending Shoulda or Test::Unit with macros for command line apps testing
-When you start thinking about writing ruby command line utility you likely want to start with writing test. Assuming command line parsing is in CliApp#run you prabably want to write something like:
+= Basic Usage
+== Installation
+sudo gem install afurmanov-clicase
+
+== Example
+Assuming you decided to write a new command line utility CliApp and you know that CliApp#run is its entry point. You may start with writing simplest test:
+
+ requie 'clicase'
+
class CliTest < Test::Unit::TestCase
run_command_line_as {CliApp.run}
run_with_options ["--help"] do
assert_successful_run
assert_out_contains /Usage:/
end
end
+= Shortcumings
-Work in progress...
+* Only tested on the 1.8.7 Ruby implementations with Shoulda 2.10.1
+