diff --git a/readme.md b/readme.md index 44e2f0b..4185396 100644 --- a/readme.md +++ b/readme.md @@ -12,7 +12,6 @@ Update `~/.tempo-tantrum` with your Jira configuration `ex. ~/.tempo-tantrum config` - jira location: https://jira-host user: user pass: pass @@ -22,48 +21,52 @@ And create your work log, a YAML list of work log items keyed by date. `ex. work-log.yaml` - 3/29/2013: - - - project: PROJECT-ID - hours: 2 - comments: > - Some comments +```yaml +3/29/2013: - - project: ANOTHER-PROJECT-ID - hours: 3 - comments: > - Some more comments + - project: PROJECT-ID + hours: 2 + comments: > + Some comments - 3/30/2013: + - project: ANOTHER-PROJECT-ID + hours: 3 + comments: > + Some more comments - - project: PROJECT-ID - hours: 2 - comments: > - Some comments +3/30/2013: - - project: ANOTHER-PROJECT-ID - hours: 3 - comments: > - Some more comments + - project: PROJECT-ID + hours: 2 + comments: > + Some comments + - project: ANOTHER-PROJECT-ID + hours: 3 + comments: > + Some more comments +``` Notice that the work log is a list of date blocks and each date block contains a list of project work log items. And run tempo-tantrum with your work log - $ tempo-tantrum le-work-log +```bash +$ tempo-tantrum le-work-log +``` OR run it without a filename for interactive mode! - $: ./tempo-tantrum - Entering interactive mode - Date (ex. 4/9/2013): 4/16/2013 - Enter work log - Project: PROJECT-ID - Hours: 1 - Comments: Some stuff - +```bash +$: ./tempo-tantrum +Entering interactive mode +Date (ex. 4/9/2013): 4/16/2013 +Enter work log +Project: PROJECT-ID +Hours: 1 +Comments: Some stuff +``` Note that tempo-tantrum is **not** stateful **nor** idempotent therefore you should be probably run tempo-tantrum with a fresh log each time.