Add basic usage examples

This commit is contained in:
Ryan Heywood 2024-11-20 11:57:04 -05:00
parent 3a9bc55a22
commit 93c2a806f1
Signed by: ryan
GPG Key ID: 8E401478A3FBEF72
1 changed files with 21 additions and 0 deletions

21
README.md Normal file
View File

@ -0,0 +1,21 @@
# Tracking Time
To start running PunchIn for a specific client, use:
```sh
cargo run -- start <client>.json
```
Enter the projects as you start working on them. Each time you switch to a new
project, the current project will be committed and rounded to the next chunk
(by default, 30 minutes). Once finished, be sure to exit the program using
ctrl-d or EOL to properly save progress.
# Generating Reports
PunchIn natively supports Markdown and CSV.
```sh
cargo run -- report <client>.json --format markdown --timescale hours
cargo run -- report <client>.json --format csv --timescale hours
```