aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fl.fischer@fau.de>2017-03-16 22:22:38 +0100
committerFlorian Fischer <florian.fl.fischer@fau.de>2017-03-16 22:22:38 +0100
commitbb1dad5ffc92239a70ab8ec646ef9bb4831c983f (patch)
treefe856315f3b15ce13f8a2c3de3dd90260a3353a6
parentad5397198e7e6582a394ff2deb1e8e11725f4153 (diff)
downloaddiary-bb1dad5ffc92239a70ab8ec646ef9bb4831c983f.tar.gz
diary-bb1dad5ffc92239a70ab8ec646ef9bb4831c983f.zip
further imrpove Readme
-rw-r--r--Readme.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/Readme.md b/Readme.md
index 2a7f354..d92d967 100644
--- a/Readme.md
+++ b/Readme.md
@@ -2,13 +2,15 @@
## Installation
-Clone the repo with:
-`clone https:/muhq.space/software/diary.git`
+Clone the repo with:
+
+`clone https:/muhq.space/software/diary.git`
+
And copy `diary` into your path.
## Usage
- diary [date] opens the diary entry from date or today if date is not provided.
+ diary [date] opens the diary entry from date or today if date is not provided in $EDITOR.
## Configuration
@@ -20,6 +22,6 @@ Diary reads the configuration from:
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
+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