README.md in zoho_hub-0.1.9 vs README.md in zoho_hub-0.1.10
- old
+ new
@@ -1,15 +1,9 @@
# ZohoHub
-[](https://travis-ci.com/rikas/zoho_hub)
+https://www.zoho.com/crm/help/api-diff/
-Simple wrapper around Zoho CRM version2, using authentication by [OAuth 2.0 protocol](https://www.zoho.com/crm/help/api/v2/#OAuth2_0).
-
-This gem reads your Module configuration and builds the corresponding classes for you.
-
-**NOTE: this gem is WIP, please try to use it and open an issue if you run into limitations / problems**
-
## Installation
Add this line to your application's Gemfile:
```ruby
@@ -24,27 +18,21 @@
$ gem install zoho_hub
## Usage
-First you need to have a configuration block like the one below:
+TODO: Write usage instructions here
-```ruby
-ZohoHub.configure do |config|
- config.client_id = 'YOUR_ZOHO_CLIENT_ID'
- config.secret = 'YOUR_ZOHO_SECRET'
- config.redirect_uri = 'YOUR_ZOHO_OAUTH_REDIRECT_URL'
- # config.debug = true # this will be VERY verbose, but helps to identify bugs / problems
-end
-```
-
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 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/rikas/zoho_hub.