README.textile in davidlee-state-fu-0.0.1 vs README.textile in davidlee-state-fu-0.0.2

- old
+ new

@@ -144,31 +144,45 @@ (coincidentally named) Stateful set a very high standard with an exceptionally elegant API. h2. Getting started -First up: +You can either clone the repository in the usual fashion (eg to +yourapp/vendor/plugins/state-fu), or use StateFu as a gem. +To install as a gem: + <pre> <code> - sudo gem install rspec rr activesupport - rake - rake spec:doc # generate specdocs - rake doc # generate rdoc - rake gem # build the gem - rake gem:install # install it +gem install davidlee-state-fu -s http://gems.github.com </code> </pre> -And have a peek in the specs folder or rdoc for usage / documentation. -Now you can simply: +To require it in your ruby project: + +<pre> <code> - require 'state-fu' +require 'rubygems' +require 'state-fu' </code> -and +</pre> + +To install the dependencies for running specs: + +<pre> <code> - include StateFu -</code> in any class you wish to make stateful. + sudo gem install rspec rr activesupport + rake # run the specs + rake spec:doc # generate specdocs + rake doc # generate rdocs + rake build # build the gem locally + rake install # install it +</code> +</pre> + +Now you can simply <code>include StateFu</code> in any class you wish to make stateful. + +The spec folder is currently the best source of documentation. If you have questions, feature request or ideas, please join the "google group":http://groups.google.com/group/state-fu Also see the "issue tracker":http://github.com/davidlee/state-fu/issues