README.md in monday_ruby-0.1.0 vs README.md in monday_ruby-0.2.0
- old
+ new
@@ -1,11 +1,17 @@
# Monday API Library for Ruby
+[](https://badge.fury.io/rb/monday_ruby)
-This library provides convenient access to the Monday.com API from the application written in the Ruby language. It includes a pre-defined set of actions for the API resources.
+This library provides convenient access to the monday.com API from the application written in the Ruby language.
+The library provides:
+
+1. A pre-defined set of methods to easily interact with the API resources.
+2. Easy configuration path for fast setup and use.
+
**Visit https://monday-ruby.gitbook.io/docs/ for detailed documentation on how to use the library.**
## Installation
You don't need the source code unless you want to modify the gem. If you want to use the package, run:
@@ -20,11 +26,11 @@
gem build monday_ruby.gemspec
```
### Requirements
-* Ruby 2.6+
+* Ruby 2.7+
### Bundler
If you are installing via bundler, you should be sure to use the https rubygems source in your Gemfile, as any gems fetched over http could potentially be compromised in transit and alter the code of gems fetched securely over https:
@@ -38,9 +44,25 @@
***Complete list of actions along with examples are provided [here](https://monday-ruby.gitbook.io/docs/).***
The library needs to be configured with your account's authentication token which is available on the Admin tab on monday.com. Elaborate documentation can be found [here](https://developer.monday.com/api-reference/docs/authentication).
+### Configuration
+
+Once you have the authentication token, you can either globally configure the library or you can configure a specific client.
+
+#### Global config
+
+```ruby
+require "monday_ruby"
+
+Monday.configure do |config|
+ config.token = "<AUTH_TOKEN>"
+end
+
+```
+
+#### Client specific config
```ruby
require "monday_ruby"
client = Monday::Client.new(token: "<AUTH_TOKEN>")
```