summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorT <t@tjp.lol>2025-08-13 16:06:36 -0600
committerT <t@tjp.lol>2025-08-13 16:34:23 -0600
commit5c3554c7e49abe263faf54c61e435ba1d5202d27 (patch)
treeba4956af69205884cc1ff3fae211dad151adc194 /README.md
parente9e6eb4e456ee53da5a6ef743251410d4d3d8381 (diff)
update TODO, and fix a crash
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 19 insertions, 3 deletions
diff --git a/README.md b/README.md
index 39f5586..ac54f5f 100644
--- a/README.md
+++ b/README.md
@@ -9,8 +9,15 @@ Punchcard helps you track your work hours and generate professional invoices and
## Quick Start
```bash
+# Set your own info
+punch set name="John Doe" label="Web Design" email="john@doe.com"
+
+# Set up a client and a project
+punch add client AcmeCorp bossman@acmecorp.com --hourly-rate 120
+punch add project -c AcmeCorp 'Website Redesign'
+
# Start tracking time
-punch in
+punch in -c AcmeCorp
# Stop tracking time
punch out
@@ -19,8 +26,8 @@ punch out
punch status
# Generate reports
-punch report invoice
-punch report timesheet
+punch report unified -c AcmeCorp -d 'last month'
+punch report timesheet -c AcmeCorp -d 'this week'
```
## Commands
@@ -38,6 +45,15 @@ punch report timesheet
### Reports
- `punch report invoice` - Generate a PDF invoice from tracked time
- `punch report timesheet` - Generate a PDF timesheet report
+- `punch report unified` - Generate a PDF containing an invoice followed by a timesheet
+
+## Full TUI
+
+```bash
+punch tui # or just `punch`
+```
+
+![screenshot of the punch TUI](tui-screenshot.jpg)
## How it works