README.md in pivotal_to_pdf-0.5.2.1 vs README.md in pivotal_to_pdf-0.6
- old
+ new
@@ -8,11 +8,11 @@
## INSTALL
$ [sudo] gem install pivotal_to_pdf
## USAGE
-First you need to create a .pivotal.yml under your home directory. No idea how you do this under Windows so no support to Windows yet
+First you need to create a .pivotal.yml under your home directory. On windows, have this file in %HOME%.pivotal.yml
a sample .pivotal.yml:
token: your-api-token-of-pivotal-tracker
project_id: your-ptroject-id
@@ -20,11 +20,14 @@
After install the gem, you can do:
* pivotal_to_pdf iteration # print stories for the current iteration into a PDF file
* pivotal_to_pdf story STORY_ID # print a single story specifed by ID into a PDF file
-
The gem will then read the story/stories and print it into a PDF file
+
+The points section will be printed only for features. Bugs and Chores don't have points
+
+Printed a green bounding box for feature, a yellow box for chores and a red box for bugs
The gem assumes that you have https access to the pivotal tracker
##Contributors
Yi Wen, Carol Nichols