doc: Add user documentation for imag-diary

This commit is contained in:
Matthias Beyer 2016-07-13 18:27:36 +02:00
parent 9b7ed8c6c1
commit f8b1d48307

View file

@ -4,9 +4,20 @@ The Diary module.
### Description
<!-- Description of the module -->
The diary module is for keeping your diary notes. It offers a self-implemented
diary which creates the entries in the store.
As of now there is only the possibility to create daily entries, but the
possibility to implement hourly or even minutely entries is there.
The module offers commands to create, delete, edit and list diary entries.
### Backends
<!-- Backends the module supports including links to external resources -->
At this moment, only the imag store is an available backend and therefor diary
entries are written to the imag store.
There is no implementation for other diary software planned _yet_, but there
might be a [jrnl](http://jrnl.sh/) backend some time, but not as long as `jrnl`
does not provide a multi-file storage system.