README.md in colt-0.1.0 vs README.md in colt-0.1.1
- old
+ new
@@ -1,8 +1,8 @@
# Colt
-This micro gem is used to subscribe to a given plan using the Stripe API. To experiment with that code, run `bin/console` for an interactive prompt.
+Colt is a micro gem used to subscribe to a given plan using the Stripe API. The plans must already exist in your account. To experiment with that code, run `bin/console` for an interactive prompt.
## Installation
Add this line to your application's Gemfile:
@@ -18,21 +18,24 @@
$ gem install colt
## Usage
-TODO: Write usage instructions here
+Please read the tests written with readability in mind. They are executable and human comprehensible documentation.
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org). To run the tests:
+```ruby
+ $ruby test/colt_test.rb
+```
+
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/colt.
-
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).