From 93c2a806f13f6a4eaec00638276c5e00c6a8173b Mon Sep 17 00:00:00 2001
From: ryan <ryan@distrust.co>
Date: Wed, 20 Nov 2024 11:57:04 -0500
Subject: [PATCH] Add basic usage examples

---
 README.md | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..1c2a0db
--- /dev/null
+++ b/README.md
@@ -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
+```