README.md in wordnik-4.07 vs README.md in wordnik-4.08
- old
+ new
@@ -1,11 +1,11 @@
wordnik rubygem
===============
-This is the official Wordnik rubygem. It fully wraps Wordnik's v4 API. Refer to
-[developer.wordnik.com/docs](http://developer.wordnik.com/docs) to play around
-in the live API sandbox. All the methods you see there are implemented in this
+This is the official Wordnik rubygem. It fully wraps Wordnik's v4 API. Refer to
+[developer.wordnik.com/docs](http://developer.wordnik.com/docs) to play around
+in the live API sandbox. All the methods you see there are implemented in this
ruby gem.
Installation
------------
@@ -67,44 +67,50 @@
Wordnik.words.search_words(:query => '*tin*', :include_part_of_speech => 'verb', :min_length => 5, :max_length => 20)
```
For a full list of available methods, check out the [Wordnik API documentation](http://developer.wordnik.com/docs).
-When you make a request using our web-based API sandbox, the response output will show you how to make the
+When you make a request using our web-based API sandbox, the response output will show you how to make the
[equivalent ruby request](http://cl.ly/9FQY). w00t!
Specs
-----
The wordnik gem uses rspec 2. To run the test suite, just type `rake` or `bundle exec rake spec` in the gem's base directory.
-Note
-----
-For testing locally, you will need to tunnel into the beta box
- ssh -f -N -L 8001:localhost:8001 beta.wordnik.com
-
-And remember to update the spec_helper
-
Contributing
------------
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
* Check out the [issue tracker](http://github.com/wordnik/wordnik-ruby/issues) to make sure someone already hasn't requested it and/or contributed it
* Fork the project
* Start a feature/bugfix branch
* Commit and push until you are happy with your contribution
* Make sure to add tests for the feature/bugfix. This is important so we don't break it in a future version unintentionally.
-Wishlist
---------
+Releasing
+---------
-* Go Kart
-* Helicopter
+```bash
+rake swagger
+open lib/version.rb # bump the version number
+rake spec # test
+git commit -am "newness" # commit
+git push origin master # push
+rake release # release
+```
Props
-----
-* Thanks to [Jason Adams](http://twitter.com/#!/ealdent) for graciously turning
+* Thanks to [Jason Adams](http://twitter.com/#!/ealdent) for graciously turning
over the [wordnik gem name](https://rubygems.org/gems/wordnik).
-* HTTP requests are made using [Typhoeus](https://github.com/dbalatero/typhoeus),
- a modern code version of the mythical beast with 100 serpent heads.
\ No newline at end of file
+* HTTP requests are made using [Typhoeus](https://github.com/dbalatero/typhoeus),
+ a modern code version of the mythical beast with 100 serpent heads.
+
+Notes
+-----
+
+* If you are using the Wordnik gem on [Heroku](http://www.heroku.com/), you'll need
+ to use a stack that is compatible with [Typhoeus](https://github.com/dbalatero/typhoeus).
+ As of 2012-08, this means the Cedar stack.