Skip to content

Commit

Permalink
Add readme info
Browse files Browse the repository at this point in the history
  • Loading branch information
Lilja committed Aug 11, 2017
1 parent 69b5788 commit 14e1acc
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ Usage: timelog
- list project
- show logs (project_id) (week) [year] [--raw]
- delete project
- start (project_id)
- --help
- --version
- --purge
Expand Down Expand Up @@ -218,7 +219,6 @@ The program will prompt for input after it has been invoked.
`--date` Optional. Possible to log for a different date, specify with `--date timestamp` where `timestamp` is something the program `date` can format.

---

##### Show logs
`timelog show logs (project id) (week) (year) | (--raw)`

Expand All @@ -243,6 +243,15 @@ Debug tool
First, checks if `xdg-open` is a command. If so, will run it. Otherwise, it will check for `$EDITOR`. If neither are present, fall back to `vim`.

---
##### Set start time for log
`timelog start (project_id)`

`start` is a keyword.

`project id` Optional/prompted. Is an ID that was specified during the creation.

Writes the time down onto the filesystem and is later read when logging.

##### Delete project
`timelog delete project`

Expand Down
1 change: 1 addition & 0 deletions bin/timelog
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ function usage {
echo " * list project"
echo " * show logs (project_id) (week) [--raw]"
echo " * delete project"
echo " * start (project_id)"
echo " * --help"
echo " * --version"
echo " * --purge"
Expand Down

0 comments on commit 14e1acc

Please sign in to comment.