From 2c03584f66d6bb05a1af4f418146e9444e5d3a49 Mon Sep 17 00:00:00 2001 From: Florian Fischer Date: Tue, 21 Mar 2017 23:01:19 +0100 Subject: add usage and license sections to Readme --- Readme.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/Readme.md b/Readme.md index d92d967..37a4b9a 100644 --- a/Readme.md +++ b/Readme.md @@ -10,7 +10,11 @@ And copy `diary` into your path. ## Usage - diary [date] opens the diary entry from date or today if date is not provided in $EDITOR. + diary [cmd] [date] + + diary [edit] [date] - open the entry date/today in $EDITOR. + diary show [date] - open the entry date/today in $PAGER. + diary help [cmd] - print a help text ## Configuration @@ -25,3 +29,7 @@ Config values: 1. `diary_location` - The path to the directory, in which the diary is stored 2. `gpg_id` - The id of the pgp public key for encryption +## License + +Diary is licensed under the [WTFPL](http://www.wtfpl.net). + -- cgit v1.2.3