README.rdoc in lab_bench-0.2.0 vs README.rdoc in lab_bench-0.2.1
- old
+ new
@@ -1,10 +1,30 @@
= lab_bench
A browser-based runner for ruby Test::Unit tests.
+== Usage
+
+Install the gem:
+
+<tt>gem install lab_bench</tt>
+
+If you're using Rails 2.x, add this to config/environment.rb:
+
+<tt>config.gem 'lab_bench'</tt>
+
+Start the server in a new console / screen:
+
+<tt>lab_bench_server</tt>
+
+Send your browser to http://localhost:9020/ then run your tests like this:
+
+<tt>rake test TESTOPTS="--runner=lab_bench"</tt>
+
== TODO
+* Buffer test events in server and replay to new browser clients so they can start "hot"
+* Browser should show whether it is connected to the server and reconnect if it dies
* Show me test failures as they happen
* Give me more context on the test suite (names of files being run, command line, project directory, etc)
* Allow me to rerun a suite
* Allow me to rerun a test
* Allow me to rerun all failed tests within a suite