README.md in tracker_api-0.2.6 vs README.md in tracker_api-0.2.7
- old
+ new
@@ -33,19 +33,28 @@
## Basic Usage
```ruby
client = TrackerApi::Client.new(token: 'my-api-token') # Create API client
-user_email = client.me.email # Get authenticated user's email
+client.me.email # Get email for the authenticated person
+client.activity # Get a list of all the activity performed the authenticated person
+client.notifications # Get notifications for the authenticated person
projects = client.projects # Get all projects
project = client.project(123456) # Find project with given ID
+project.activity # Get a list of all the activity performed on this project
project.stories # Get all stories for a project
project.stories(with_state: :unscheduled, limit: 10) # Get 10 unscheduled stories for a project
project.stories(filter: 'requester:OWK label:"jedi stuff"') # Get all stories that match the given filters
-project.story(847762630) # Find a story with the given ID
project.create_story(name: 'Destroy death star') # Create a story with the name 'Destroy death star'
+
+story = project.story(847762630) # Find a story with the given ID
+story.activity # Get a list of all the activity performed on this story
+
+story.name = 'Save the Ewoks' # Update a single story attribute
+story.attributes = { name: 'Save the Ewoks', description: '...' } # Update multiple story attributes
+story.save # Save changes made to a story
epics = project.epics # Get all epics for a project
epic = epics.first
label = epic.label # Get an epic's label
```