Skip to content

Commit

Permalink
fix typo in find since it takes integers not strings, updated readme …
Browse files Browse the repository at this point in the history
…with creation api for stories
  • Loading branch information
jsmestad committed Mar 1, 2010
1 parent bc841ff commit edd20b7
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.rdoc
Expand Up @@ -18,12 +18,15 @@ Version 0.0.8 and above are incompatible with previous versions.
PivotalTracker::Client.token = 'jkfduisj97823974j2kl24899234' # Manually set API Token

@projects = PivotalTracker::Project.all # return all projects
@a_project = PivotalTracker::Project.find('84739') # find project with a given ID
@a_project = PivotalTracker::Project.find(84739) # find project with a given ID

@a_project.stories.all # return all stories for "a_project"
@a_project.stories.all(:label => 'overdue', :story_type => ['bug', 'chore']) # return all stories that match the passed filters
@a_project.stories.find('847762630') # find story with a given ID
@a_project.stories.find(847762630) # find story with a given ID

@a_project.stories.create(:name => 'My Story', :story_type => 'feature') # create a story for this project
@a_project.stories << PivotalTracker::Story(84739, :name => 'Another Story') # same as above, useful for copying/cloning from proj

# all tracker defined filters are allowed, as well as :limit & :offset for pagination

The API is based on the following this gist: http://gist.github.com/283120
Expand All @@ -50,4 +53,4 @@ Documentation: http://rdoc.info/projects/jsmestad/pivotal-tracker

* Justin Smestad (http://github.com/jsmestad)
* Josh Nichols (http://github.com/technicalpickles)
* Terence Lee (http://github.com/hone)
* Terence Lee (http://github.com/hone)

0 comments on commit edd20b7

Please sign in to comment.