diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 22 |
1 files changed, 19 insertions, 3 deletions
@@ -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` +``` + + ## How it works |