README.md in tracker_api-1.6.0 vs README.md in tracker_api-1.7.0
- old
+ new
@@ -8,11 +8,11 @@
This gem allows you to easily use the [Pivotal Tracker v5 API](https://www.pivotaltracker.com/help/api/rest/v5).
It’s powered by [Faraday](https://github.com/lostisland/faraday) and [Virtus](https://github.com/solnic/virtus).
-##Demonstration
+## Demonstration
[Dash of Agile](https://www.dashofagile.com) uses `tracker_api` to create agile dashboards from Pivotal Tracker projects.
## Installation
Add this line to your application's Gemfile:
@@ -46,10 +46,12 @@
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.create_story(name: 'Destroy death star') # Create a story with the name 'Destroy death star'
+project.search('Destroy death star') # Get a search result with all epics and stories relevant to the query
+
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.transitions # Get a list of all the story transitions on this story
story.name = 'Save the Ewoks' # Update a single story attribute
@@ -88,10 +90,9 @@
client = TrackerApi::Client.new(token: 'my-api-token') # Create API client
client.project(project_id, fields: ':default,labels(name)') # Eagerly get labels with a project
client.project(project_id, fields: ':default,epics') # Eagerly get epics with a project
client.project(project_id).stories(fields: ':default,tasks') # Eagerly get stories with tasks
-client.project.stories(fields: ':default,comments(:default,person)') # Eagerly get stories with comments and the person that made the comment
story.comments(fields: ':default,person') # Eagerly get comments and the person that made the comment for a story
```
## Warning