Permalink
Browse files

Add some more about how to use PROJECT to filter and the 'to_date' to…

… the README. ALso switch to markdown.
  • Loading branch information...
1 parent cf57438 commit b154b8ebc227a15156ee58a7a9a72bde004b4ae1 Brian Cooke committed Mar 13, 2012
Showing with 9 additions and 3 deletions.
  1. +9 −3 README → README.mdown
@@ -1,14 +1,20 @@
-Usage:
+**Usage:**
-FBAPI_TOKEN={YOUR_FRESHBOOKS_API_TOKEN} bundle exec ./fbtoday.rb [2012-02-27]
+<pre><code>
+FBAPI_TOKEN={YOUR_FRESHBOOKS_API_TOKEN} bundle exec ./fbtoday.rb [2012-02-27] [2012-02-30]
+</code></pre>
-If you don't pass a date, Date.today is used.
+If you don't pass a date for the from or to dates, Date.today is used.
Output:
+<pre><code>
6.0 Project Name What I did for that project
2.0 Project Name What I did for that project
----
8.0
+</code></pre>
I use this as a simple way to see what I did today and to cut and paste the report for one of my clients who requires an email status report with a detailed log.
+
+If you want to filter by project, pass PROJECT as an environment variable like PROJECT="Project Name".

0 comments on commit b154b8e

Please sign in to comment.