diff options
Diffstat (limited to 'Readme.md')
| -rw-r--r-- | Readme.md | 23 |
1 files changed, 20 insertions, 3 deletions
@@ -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 |