README.md in pivotal-github-1.1.7 vs README.md in pivotal-github-1.2.0
- old
+ new
@@ -145,9 +145,16 @@
The `story-open` command (no `git`) opens the current story in the default browser (OS X–only):
$ story-open
+### project-open
+
+The `project-open` command (no `git`) opens the current project in the default browser (OS X–only):
+
+ $ project-open
+
+`project-open` requires the existence of file containing the project id with filename `.project_id` in the project's root directory. If it doesn't exist, the user is prompted to create it, and for safety it is automatically added to the `.gitignore` file.
## Configuration
In order to use the `pivotal-github` gem, you need to configure a post-receive hook for your repository. At GitHub, navigate to `Settings > Service Hooks > Pivotal Tracker` and paste in your Pivotal Tracker API token. (To find your Pivotal Tracker API token, go to your user profile and scroll to the bottom.) Be sure to check the **Active** box to activate the post-receive hook. At Bitbucket, click on the gear icon to view the settings, click on `Services`, select `Pivotal Tracker`, and paste in your Pivotal Tracker API key. In addition, the `git story-accept` command requires the existence of `.api_token` and `.project_id` files containing the Pivotal Tracker API token and project id, respectively.