README.md in oxr-0.5.0 vs README.md in oxr-0.6.0
- old
+ new
@@ -63,11 +63,11 @@
You perform more complex operations by using the lower-level API calls. These
methods return the raw JSON responses returned by Open Exchange Rates (parsed
using the [json](https://rubygems.org/gems/json) gem).
-Get the latest exchange rates with `OXR#latest`.
+Get the latest exchange rates with `OXR.latest`.
```ruby
OXR.latest
```
@@ -90,28 +90,28 @@
"ZWL"=>322.355011
}
}
```
-Get historical exchange rates for specific dates with `OXR#historical`. This
+Get historical exchange rates for specific dates with `OXR.historical`. This
method requires you to provide the date you wish to lookup. The date argument
should respond to `#strftime`.
```ruby
OXR.historical on: Date.new(2016, 3, 24)
```
-This will return a JSON object with a structure similar to that returned by `OXR#latest`.
+This will return a JSON object with a structure similar to that returned by `OXR.latest`.
-Get a list of available currencies with `OXR#currencies`.
+Get a list of available currencies with `OXR.currencies`.
```ruby
OXR.currencies
```
Get information about your account including your usage for the current period
-with `OXR#usage`.
+with `OXR.usage`.
```ruby
OXR.usage
```
@@ -168,17 +168,25 @@
(You can still call `OXR.new`, but this behavior will generate a deprecation
warning.)
## 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.
+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).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/jparker/oxr.
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/jparker/oxr.
## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).