README.md in balanced-0.2.5 vs README.md in balanced-0.3.0

- old
+ new

@@ -1,8 +1,8 @@ # Balanced -TODO: Write a gem description +Online Marketplace Payments ## Installation Add this line to your application's Gemfile: @@ -16,14 +16,43 @@ $ gem install balanced ## Usage -TODO: Write usage instructions here +See https://www.balancedpayments.com/docs/ruby for tutorials and documentation. + ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am 'Add some feature'`) 4. Push to the branch (`git push origin my-new-feature`) 5. Create new Pull Request + + +### Specs + +The spec suite is a work in progress. Existing specs can either be run +using [guard](https://github.com/guard/guard) or rake. + +Guard + + $ bundle exec guard + +Rake + + $ rake spec + +We use [VCR](https://www.relishapp.com/myronmarston/vcr/docs) to stub +out and save http interactions. Cassettes are not stored in the repo. +They are generated the first time the spec suite is run and stored in +spec/cassettes. To clear them and regenerate: + + $ rm -rf spec/cassettes + + +### Building Documentation + +Documentation is build using YARD - http://rubydoc.info/docs/yard + + yard doc -e doc/balanced_plugin.rb -p doc/balanced_templates/ 'lib/**/resources.rb' --one-file