Skip to content
This repository
Browse code

updated README

  • Loading branch information...
commit aa41646e08150956fd6c34aa6cd060aebbcbbfa4 1 parent 5b31388
Justin Smestad authored

Showing 1 changed file with 32 additions and 8 deletions. Show diff stats Hide diff stats

  1. +32 8 README.rdoc
40 README.rdoc
Source Rendered
@@ -2,7 +2,31 @@
2 2
3 3 Ruby wrapper for Pivotal Tracker API, no frameworks required. Simply Ruby.
4 4
5   -Documentation: http://rdoc.info/projects/jsmestad/pivotal-tracker
  5 +== Note
  6 +
  7 +Version 0.0.8 and above are incompatible with previous versions.
  8 +
  9 +== Features
  10 +
  11 +* Compatible with Pivotal Tracker API version 3
  12 +* ActiveRecord-style Wrapper API
  13 +* Support for SSL protected repositories
  14 +
  15 +== Overview
  16 +
  17 + PivotalTracker::Client.token('myusername@email.com', 'secretpassword') # Automatically fetch API Token
  18 + PivotalTracker::Client.token = 'jkfduisj97823974j2kl24899234' # Manually set API Token
  19 +
  20 + @projects = PivotalTracker::Project.all # return all projects
  21 + @a_project = PivotalTracker::Project.find('84739') # find project with a given ID
  22 +
  23 + @a_project.stories.all # return all stories for "a_project"
  24 + @a_project.stories.all(:label => 'overdue', :story_type => ['bug', 'chore']) # return all stories that match the passed filters
  25 + @a_project.stories.find('847762630') # find story with a given ID
  26 +
  27 + # all tracker defined filters are allowed, as well as :limit & :offset for pagination
  28 +
  29 +The API is based on the following this gist: http://gist.github.com/283120
6 30
7 31 == Getting Started
8 32
@@ -10,17 +34,17 @@ Documentation: http://rdoc.info/projects/jsmestad/pivotal-tracker
10 34
11 35 $ gem install pivotal-tracker
12 36
13   -* Contributing:
  37 +* Contributing (requires Bundler >= 0.9.7):
14 38
15 39 $ git clone git://github.com/jsmestad/pivotal-tracker
16 40 $ cd pivotal-tracker
17   - $ gem bundle
18   - $ ./gbin/rake
  41 + $ bundle install
  42 + $ bundle exec rake
  43 +
  44 +== Additional Information
19 45
20   -== Notes
21   -
22   -There are a few areas that need to be modified in order for this code to work correctly.
23   -You must set the Token key in the initialize method as well as project_id.
  46 +Wiki: http://wiki.github.com/jsmestad/pivotal-tracker
  47 +Documentation: http://rdoc.info/projects/jsmestad/pivotal-tracker
24 48
25 49 == Contributers
26 50

0 comments on commit aa41646

Please sign in to comment.
Something went wrong with that request. Please try again.