aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
blob: 37a4b9a7348a8cb1104cf11907c282d1d6b8b471 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Diary - Personal diary

## Installation

Clone the repo with:

`clone https:/muhq.space/software/diary.git`

And copy `diary` into your path.

## Usage

	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

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

## License

Diary is licensed under the [WTFPL](http://www.wtfpl.net).