README.md in pivotal_angel-0.0.1 vs README.md in pivotal_angel-0.0.2
- old
+ new
@@ -1,8 +1,8 @@
# PivotalAngel
-TODO: Write a gem description
+ A helper gem for manipulating Pivotal Tracker from within a Ruby app. Supplements the pivotal-tracker gem.
## Installation
Add this line to your application's Gemfile:
@@ -10,16 +10,36 @@
And then execute:
$ bundle
-Or install it yourself as:
+Or install it yourself:
$ gem install pivotal_angel
## Usage
-TODO: Write usage instructions here
+# Create a deep clone of a project. Copies over stories, tasks and notes.
+
+ source_project = PivotalTracker::Project.find 123456
+ PivotalAngel::Project.deep_clone(source_project, 'cloned_project')
+
+# Rename a label
+
+ project = PivotalTracker::Project.find 123456
+ PivotalAngel::Label.rename(project, 'old_label', 'new_label')
+
+# Add a 'expense' label to all stories with the label 'shopping'
+
+ project = PivotalTracker::Project.find 123456
+ stories = project.stories.all(:labels => 'shopping')
+ PivotalAngel::Label.apply_to(stories, 'expense')
+
+# Remove the 'expense' label from all stories
+
+ project = PivotalTracker::Project.find 123456
+ stories = project.stories.all(:labels => 'expense')
+ PivotalAngel::Label.remove_from(stories, 'expense')
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)