README.md in bugherd_client-0.0.5 vs README.md in bugherd_client-0.0.6
- old
+ new
@@ -1,8 +1,13 @@
-# BugherdClient
+[](http://badge.fury.io/rb/bugherd_client)
+[](https://gemnasium.com/jwaterfaucett/bugherd_client)
+[](https://travis-ci.org/jwaterfaucett/bugherd_client)
-This is a Rest Client for the Bugherd API. It fully covers all methods of the v1 and v2 API Implementations.
+
+# BugHerd Client
+
+This is a Rest Client for the BugHerd API. It fully covers all methods of the v1 and v2 API Implementations.
Another nifty feature is that its threadsafe so you could potentially have many instances floating around and don't
have to worry about collisions as is the case with ActiveResource.
## Installation
@@ -20,24 +25,34 @@
## Basic Usage
```ruby
-client = BugherdClient::Client.new(api_key: 'someapikey', api_version: 2) # api_version 2 is the default
+# create a client form an api_key, it will automatically use v2 of the BugHerd API
+client = BugherdClient::Client.new(api_key: 'someapikey')
+
+# Get information about your organization
client.organization.get # => returns your organization information
-client.users.all # => returns a list of all users
+
+# Get a list of all users
+all_users = client.users.all # => returns a list of all users
+user = all_users.first
+
+# Find a specific project
project = client.projects.find(1023)
-user = client.users.all.first
-client.tasks.create(project[:id], {
- description: 'Some description',
+# Create a new Task
+task = client.tasks.create(project[:id], {
+ description: 'This is a description',
requester_id: user[:id],
- status: BugherdClient::Resources::Task::STATUS_BACKLOG,
- priority: BugherdClient::Resources::Task::PRIORITY_NORMAL,
- external_id: 'my-external-app-123'
+ status: 'backlog',
+ priority: 'normal'
})
-
+# Create a comment
+client.comments.create(project[:id], task[:id], {
+ text: 'hey this is a comment'
+})
```
## Contributing