README.md in oxford_dictionary-0.1.0 vs README.md in oxford_dictionary-1.0.0
- old
+ new
@@ -1,8 +1,9 @@
[](https://travis-ci.org/swcraig/oxford-dictionary)
[](https://codeclimate.com/github/swcraig/oxford-dictionary/coverage)
[](https://codeclimate.com/github/swcraig/oxford-dictionary)
+[](https://badge.fury.io/rb/oxford_dictionary)
# OxfordDictionary
Ruby wrapper to consume the [Oxford Dictionary API](https://developer.oxforddictionaries.com/documentation)
## Getting Started
@@ -16,10 +17,15 @@
client = OxfordDictionary::Client.new(app_id: 'ID', app_key: 'SECRET')
client = OxfordDictionary.new(app_id: 'ID', app_key: 'SECRET')
### Usage Examples
+Some documentation on the different endpoint function calls can be found [here](http://rubydoc.info/gems/oxford_dictionary/OxfordDictionary/Endpoints)
+
+This wrapper follows the schema laid out by the API quite closely. The data
+schema for the different API calls can be found [here](https://developer.oxforddictionaries.com/documentation).
+
###### Get the results for an entry
entry = client.entry('vapid')
# Access the first entry
@@ -66,11 +72,11 @@
# Or the search endpoint
search_results = client.search('condition', prefix: true)
###### A quick note on how to add filters to queries
-There isn't much argument checking at the moment. Some endpoints do not accept filter arguments, refer to the API documentation to check for endpoints that accept filters.
+There isn't much argument checking at the moment. Some endpoints do not accept filter arguments, refer to the API documentation to check for endpoints that accept filters.
# All endpoints accept the :lang filter. This specifies which dictionary to use
# If no argument is supplied, default is 'en'
filters = { lang: 'es' }
@@ -83,16 +89,16 @@
Argument names need to be in camelCase, not snake_case. However, the objects returned from API calls use snake_case attributes.
## Development
-After checking out the repo, run `bin/setup` to install dependencies.
+After checking out the repo, run `bin/setup` to install dependencies.
Run `bin/console` for an interactive prompt that will allow you to experiment.
## Contributing
-Bug reports and pull requests are more than welcome!
-Please make tests for anything that is added.
+Bug reports and pull requests are more than welcome!
+Please make tests for anything that is added.
`bundle exec rake` will run rspec/rubocop.
#### Pull Requests
- Read [this often cited resource on contributing to open source projects on GitHub](https://gun.io/blog/how-to-github-fork-branch-and-pull-request)
- Fork the project