Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
frapa committed Feb 27, 2020
1 parent e1d2441 commit 4c5fd88
Showing 1 changed file with 38 additions and 3 deletions.
41 changes: 38 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,16 +58,40 @@ You can get a the total time logged with the `report` command.
It works like this:

```bash
$ timers report days
$ timers report days # Or even simply timer report
Mon: 2h 16m
Tue: 6h 34m
Wed: 4h 10m
Thu: 8h 37m
Fri: 0s
Sat: 0s
Sun: 0s
```

### "Advanced" features

You can start logging at a certain time with:

```bash
$ timers log "Your task" --at 10:34
# You can also set the time to yesterday, by prepending y
$ timers log "Your task" --at y10:34 # yesterday at 10:34
# Or you can use relative time with + and -
$ timers log "Your task" --at -10 # 10 minutes ago
```

The nice thing is that if you're already logging, it will end
the current task at the specified past time point, so no overlapping
tasks will be logged!

## FAQ

**Why should I choose `timers` instead of any other time tracking tool**

3 reasons:

- You're a nerd and like to show off how superior you are.
- You like simple things like plain text files. Who ever want a database instead of those?
- Let your colleagues think you're a genius who's always mysteriously typing into a black box.
- You believe global warming is a threat or you're laptop has a really shitty battery.
- Colored terminal output. This alone would be enough do discard any competing tool.

Expand All @@ -79,4 +103,15 @@ or even worse web-based solution.

You're free to use your web-based tool that will eat 100 MB of your memory, download 10 Mb
of crap (including the very necessary 8 Mb of javascript code) just so you can click
the "log" button on a task.
the "log" button on a task.

**Where is my data stores? Are you stealing it?**

No way, it's all in the `.timers` folder inside your user folder (typically
`/home/<yourusername>/.timers` on unix systems and `C:\Users\<yourusername>\.timers`
on Windows).

**`timers` has a bug, what do I do?**

File a issue on the tab above. If the gods of the internet are favourable, I might
look into fixing it. Please provide a decent bug report.

0 comments on commit 4c5fd88

Please sign in to comment.