tracker-ical

tracker-ical copied to clipboard

= tracker-ical

PivotalTracker iterations and releases output as an iCalendar feed.

== Requirements

• PivotalTracker account with API access. Signup at Pivotal[https://www.pivotaltracker.com/signup/new].
• API token for the account

== Configuration Can be done with individual calls:

TrackerIcal.token('[email protected]', 'secretpassword') # Automatically fetch API Token from PivotalTracker TrackerIcal.token = 'jkfduisj97823974j2kl24899234' # Manually set API Token for PivotalTracker TrackerIcal.use_ssl = true # Set to true if account requires SSL. Default is false

There is also support for setting both the token & ssl in a single call TrackerIcal.configure({:token => 'jkfduisj97823974j2kl24899234', :use_ssl => true})

== Usage TrackerIcal.calendar_for_project(project_id) #Pass the project_id of the PivotalTracker project to generate iCal string for

TrackerIcal.ics_file_for_project(filepath,project_id) #Generates an ics file at the specified filepath for the PivotalTracker project with project_id

== Changelog

See CHANGELOG for details

== Note on Patches/Pull Requests

• Fork the project.
• Make your feature addition or bug fix.
• Add tests for it. This is important so I don't break it in a future version unintentionally.
• Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
• Send me a pull request. Bonus points for topic branches.

== Copyright

Copyright (c) 2010 Niels Meersschaert. See LICENSE for details.