summaryrefslogtreecommitdiffstats
path: root/libimagdiary
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2016-08-24 14:22:01 +0200
committerMatthias Beyer <mail@beyermatthias.de>2016-08-24 14:22:20 +0200
commit47588dc2f3a1c1b89910d83fe7ae6303d8543e01 (patch)
treef56dd8237d5b9b087171540d6c448e6f654bfac6 /libimagdiary
parent62a7e75230effca3c050cb4d3121d336587dd62a (diff)
Add README.md for libimagdiary
Diffstat (limited to 'libimagdiary')
-rw-r--r--libimagdiary/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/libimagdiary/README.md b/libimagdiary/README.md
new file mode 100644
index 00000000..0c2df2cd
--- /dev/null
+++ b/libimagdiary/README.md
@@ -0,0 +1,16 @@
+# libimagdiary
+
+This library crates implements a full diary.
+
+One can have one or more diaries in the store, each diary can have unlimited
+entries.
+
+## Future plans
+
+The diary should be able to provide _daily_, _hourly_ and even _minutely_
+diary entries, so one can use the diary as normal "Dear diary,
+today..."-diary, or more fine-grained and more like a journal.
+
+The internal file format as well as the store-path generation for this module is
+prepared for such functionality.
+