README.markdown in citrusbyte-stories-0.0.9 vs README.markdown in citrusbyte-stories-0.1.0

- old
+ new

@@ -54,10 +54,21 @@ Or with a regular expression: $ ruby my_test.rb -n /yet_more_tests/ +Pending stories +--------------- + +Since Stories aims to improve your project's documentation, you can have pending stories: + + class UserStoryTest < Test::Unit::TestCase + story "As a user I want to create stories so I can test if they pass" + end + +This is useful if you want to write all your stories upfront, even before you write the acceptance tests. + Awesome output -------------- You can get a nice output with your user stories with the `stories` runner: @@ -66,9 +77,14 @@ Now, if you want to impress everyone around you, try this: $ ruby my_test.rb --runner=stories-pdf You will get a nicely formatted PDF with your user stories. It uses [Prawn](http://prawn.majesticseacreature.com/), so you will need to install it first. + +If you're using Rails, you can run the whole build with the following Rake tasks: + + $ rake stories + $ rake stories:pdf Installation ------------ $ sudo gem install stories