README.md in bugherd_client-0.0.6 vs README.md in bugherd_client-0.0.8
- old
+ new
@@ -3,62 +3,47 @@
[](https://travis-ci.org/jwaterfaucett/bugherd_client)
# 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.
+This is a Rest Client for the BugHerd API.
-## Installation
+**features:**
-Add this line to your application's Gemfile:
+* Threadsafe
+* Full V1 API support
+* Full V2 API support
- gem 'bugherd_client'
+**ruby support:**
-And then execute:
+* JRuby
+* Rubinius 2+
+* MRI >= 1.9.3
- $ bundle
-Or install it yourself as:
+## Installation
$ gem install bugherd_client
## Basic Usage
-```ruby
+For usage look in the examples folders. Examples are only kept for the latest
+version of the API so if you really want to use older versions you'll have to
+look at the source.
-# create a client form an api_key, it will automatically use v2 of the BugHerd API
-client = BugherdClient::Client.new(api_key: 'someapikey')
+* [Setup](examples/initialization.rb)
+* [Projects](examples/projects.rb)
+* [Users & Organization](examples/users_and_organization.rb)
+* [Task & Comments](examples/tasks_and_comments.rb)
+* [Attachments](examples/attachments.rb)
+* [Webhooks](examples/webhooks.rb)
-# Get information about your organization
-client.organization.get # => returns your organization information
-
-# 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)
-
-# Create a new Task
-task = client.tasks.create(project[:id], {
- description: 'This is a description',
- requester_id: user[:id],
- status: 'backlog',
- priority: 'normal'
-})
-
-# Create a comment
-client.comments.create(project[:id], task[:id], {
- text: 'hey this is a comment'
-})
-
-```
-
## Contributing
+Please note that all contributions require tests.
+
1. Fork it ( http://github.com/<my-github-username>/bugherd_client/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Write some tests.
+6. Create new Pull Request