README.md in zendesk2-0.1.2 vs README.md in zendesk2-0.1.3
- old
+ new
@@ -26,26 +26,27 @@
```yaml
---
:subdomain: zendeskdev
:username: zendeskedge@example.com
:password: wickedsecurepassword
+:token: reallylongrandomstringprovidedbyzendesk
```
### Creating the client
-Either the absolute url or the subdomain is required. Username and password is always required.
+Either the absolute url or the subdomain is required. Username and either password or token are always required.
```ruby
Zendesk2::Client.new(subdomain: "engineyard", username: "orchestra", password: "gwoo")
=> #<Zendesk2::Client::Real:0x007f99da1f9430 @url="https://engineyard.zendesk.com/api/v2", @username="orchestra", @password="gwoo", …>
```
or
```ruby
-Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate", password: "bambilla")
-=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @password="bambilla", …>
+Zendesk2::Client.new(url: "http://support.cloud.engineyard.com", username: "mate", token: "asdfghjkl1qwertyuiop5zxcvbnm3")
+=> #<Zendesk2::Client::Real:0x007fd1bae486b0 @url="http://support.cloud.engineyard.com", @username="mate", @token="asdfghjkl1qwertyuiop5zxcvbnm3", …>
```
### Resources
#### Collections
@@ -53,9 +54,10 @@
Currently support resources
* Audit Events
* Categories
* Forums
+* Groups
* Organization
* Ticket Audits
* Tickets
* Topic Comments
* Topics