README.md in synonymous-0.1.0 vs README.md in synonymous-0.2.0
- old
+ new
@@ -1,11 +1,9 @@
# Synonymous
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/synonymous`. To experiment with that code, run `bin/console` for an interactive prompt.
+An API client for Merriam-Webster's Collegiate Thesaurus
-TODO: Delete this and the text above, and describe your gem
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -20,20 +18,27 @@
$ gem install synonymous
## Usage
-TODO: Write usage instructions here
+```ruby
+require "synonymous"
+client = Synonymous::Client.new(api_key: API_KEY)
+client.get("hello")
+```
+You can get an API key from https://dictionaryapi.com/register/index
+
+
## 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).
## Contributing
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/synonymous.
+Bug reports and pull requests are welcome on GitHub at https://github.com/boblail/synonymous.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).