README.md in monday_ruby-0.2.0 vs README.md in monday_ruby-0.3.0
- old
+ new
@@ -1,16 +1,18 @@
# Monday API Library for Ruby
![Build Status](https://github.com/sanifhimani/monday_ruby/actions/workflows/ci.yml/badge.svg)
[![Gem Version](https://badge.fury.io/rb/monday_ruby.svg)](https://badge.fury.io/rb/monday_ruby)
+[![Coverage Status](https://coveralls.io/repos/github/sanifhimani/monday_ruby/badge.svg?branch=main)](https://coveralls.io/github/sanifhimani/monday_ruby?branch=main)
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.
+3. Easy error handling.
**Visit https://monday-ruby.gitbook.io/docs/ for detailed documentation on how to use the library.**
## Installation
@@ -64,9 +66,20 @@
#### Client specific config
```ruby
require "monday_ruby"
client = Monday::Client.new(token: "<AUTH_TOKEN>")
+```
+
+You can optionally pass in the version of the API you want to use using the version configuration field. By default, the latest stable version is used.
+
+```ruby
+require "monday_ruby"
+
+Monday.configure do |config|
+ config.token = "<AUTH_TOKEN>"
+ config.version = "2023-07"
+end
```
### Accessing a response object
Get access to response objects by initializing a client and using the appropriate action you want to perform: