diff options
| author | Teddy Wing | 2017-06-04 02:29:23 +0200 |
|---|---|---|
| committer | Teddy Wing | 2017-06-04 02:29:23 +0200 |
| commit | 68a64affdecfc6edab9805dfa56d4f8a78446d0e (patch) | |
| tree | 72f7dbd31f79675c993789c4b226162e55f23e28 | |
| parent | 8bada0d8dd0f31875988d513f883ca4114f86f5c (diff) | |
| download | timetasker-68a64affdecfc6edab9805dfa56d4f8a78446d0e.tar.bz2 | |
README: Add information about the `--list-modules` flag
Realised that I forgot to explain this flag. Show an example of it usage
and output, and describe some of the reasoning behind why it's there.
| -rw-r--r-- | README.md | 16 |
1 files changed, 16 insertions, 0 deletions
@@ -106,6 +106,22 @@ Once you have a complete config file, you should be all set to start posting time entries! +Eventually, you'll have to update the `module` value in your configuration file +to align with the current sprint. Instead of visiting the website to get the new +ID of the `module`, the modules of a project can be listed from the program: + + $ timetasker --project example --list-modules + +This produces the following output: + + ID Module + 77777 Sprint 1 + 222222 Sprint 2 + +The correct sprint ID can then be easily copied from this list into +`config.toml`. + + ## Install Visit the [releases][3] page, download the version corresponding to your platform, and put the resulting `timetasker` binary on your PATH. |