From ad5397198e7e6582a394ff2deb1e8e11725f4153 Mon Sep 17 00:00:00 2001
From: Florian Fischer <florian.fl.fischer@fau.de>
Date: Thu, 16 Mar 2017 22:14:19 +0100
Subject: improve README

---
 Readme.md | 23 ++++++++++++++++++++---
 1 file changed, 20 insertions(+), 3 deletions(-)

diff --git a/Readme.md b/Readme.md
index b86b836..2a7f354 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,8 +1,25 @@
 # Diary - Personal diary
 
+## Installation
+
+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.
+
+
 ## Configuration
 
-diary reads files at:
+Diary reads the configuration from:
+
+1. `$XDG_CONFIG/diary/config` or `$HOME/.config/diary/config`
+2. `$HOME/.diaryrc`
+
+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. $XDG_CONFIG/diary/config
-2. $HOME/.diaryrc
-- 
cgit v1.2.3