Permalink
Browse files

Add some installation documentation.

  • Loading branch information...
1 parent da0d1e0 commit 487dc03d8c0b8af3654623fbc5b6eee115f303a2 @mike-burns committed Dec 28, 2011
Showing with 37 additions and 15 deletions.
  1. +37 −15 README.md
View
52 README.md
@@ -3,6 +3,23 @@ Trajectory
Tools and a library.
+Installation
+============
+
+ % cabal install trajectory
+ % export PATH=~/.cabal/bin
+ % inittj
+
+You can find your API key in [the Trajectory settings](https://www.apptrajectory.com/profile/edit).
+
+The account name and project name come from the URL:
+
+ https://www.apptrajectory.com/ACCOUNTNAME/PROJECTNAME/stories
+
+It probably makes a ton of sense to use a shell alias:
+
+ % alias lsos='lsstory thoughtbot opensource'
+
Synopsis
========
@@ -11,23 +28,23 @@ Done:
% inittj
% inittj --profile thoughtbot-support
- % lsstory
- % lsstory --idea "Spam is out of control"
- % lsstory --next
- % lsstory --unstarted
- % lsstory --unestimated
- % lsstory --unstarted --next --unassigned --incomplete
- % lsstory --within-milestone "Fully Backboned"
- % lsstory --profile thoughtbot-support --project "Trajectory"
- % lsstory --completed
+ % lsstory accountname projectname
+ % lsstory accountname projectname --idea "Spam is out of control"
+ % lsstory accountname projectname --next
+ % lsstory accountname projectname --unstarted
+ % lsstory accountname projectname --unestimated
+ % lsstory accountname projectname --unstarted --next --unassigned --incomplete
+ % lsstory accountname projectname --within-milestone "Fully Backboned"
+ % lsstory accountname projectname --profile thoughtbot-support --project "Trajectory"
+ % lsstory accountname projectname --completed
- % lsstory --development
- % lsstory --design
- % lsstory --design --development
+ % lsstory accountname projectname --development
+ % lsstory accountname projectname --design
+ % lsstory accountname projectname --design --development
- % lsstory --all-iterations
- % lsstory --current-iteration
- % lsstory --iteration 2012-01-02
+ % lsstory accountname projectname --all-iterations
+ % lsstory accountname projectname --current-iteration
+ % lsstory accountname projectname --iteration 2012-01-02
To do:
@@ -38,3 +55,8 @@ To do:
% mkstory "As a user I want to always be signed in so I don't have to care"
% mkstory "As an admin I want to delete comments so I can remove spam" --idea "Spam is out of control"
% mkstory "As a visitor I am not able to see private messages so I can maintain security" -m -a screenshot.png --top
+
+Copyright
+=========
+
+Copyright 2011 Mike Burns

0 comments on commit 487dc03

Please sign in to comment.