aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2017-03-21 23:01:19 +0100
committerFlorian Fischer <florian.fl.fischer@fau.de>2017-03-21 23:01:19 +0100
commit2c03584f66d6bb05a1af4f418146e9444e5d3a49 (patch)
treec8e34ba3b23c5a12d59b7eaae7b736048f48e8ca /Readme.md
parent5de90caaf91acc52be481680fac61107542c5895 (diff)
downloaddiary-2c03584f66d6bb05a1af4f418146e9444e5d3a49.tar.gz
diary-2c03584f66d6bb05a1af4f418146e9444e5d3a49.zip
add usage and license sections to Readme
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md10
1 files changed, 9 insertions, 1 deletions
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).
+