added a quick note to the readme for the startDate.

poutinedev · Jul 12, 2019 · 3653c11 · 3653c11
1 parent a09786a
commit 3653c11
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -52,9 +52,11 @@ $ yarn global upgrade @poutine/timeular-cli@latest
 Generates a report based on the current date, filtered by your Mentions (`@`)
 
 ```
-$ timeular report
+$ timeular report [startDate]
 ```
 
+`[startDate]` needs to be in a YYYY-MM-DD format.
+
 This will not show any time entries that have not been flagged by an `@` mention. For my purposes, this is useful, because I only need to clock time that I have flagged to Jira issues.
 
 Example output: