Add README

ab41afed · Thomas R. Koll · 673f3c34 · ab41afed
Commit ab41afed authored Jan 03, 2018 by Thomas R. Koll
Hide whitespace changes
Inline Side-by-side

Showing with 19 additions and 0 deletions

README.md README.md +19 -0

No files found.
--- a/README.md
+++ b/README.md
+# A mood tracker written in Ruby.
+
+Licensed under MIT License.
+
+Needs the chronic gem as sole dependency.
+
+Usage:
+
+ `$ mood`
+ Lists your mood average over the last week
+
+ `$ mood 100`
+ Writes an entry into your `$HOME/.mood` file with the current date
+
+ `$ mood 20 date="yesterday at 4pm"`
+ Writes an entry for yesterday at 1600 hours. [https://github.com/mojombo/chronic](chronic) has quite a few possibilities for your date entry.
+
+(C) 2018 Thomas R. Koll
+