summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthias Beyer <mail@beyermatthias.de>2017-06-29 14:52:19 +0200
committerGitHub <noreply@github.com>2017-06-29 14:52:19 +0200
commit7dea53c6c00ad615ffcfb372859fcd61d08c4a21 (patch)
treeb50d982fc8556b67fe2341dc30e4476932fa1c3b
parent1b88c22decf168e2e02961c85cf5190ed44b6dc5 (diff)
parent9583ae06cdc2f6ab9286814ec08bf3786c0c572c (diff)
downloadimag-7dea53c6c00ad615ffcfb372859fcd61d08c4a21.zip
imag-7dea53c6c00ad615ffcfb372859fcd61d08c4a21.tar.gz
Merge pull request #982 from matthiasbeyer/libimagannotation/add-doc
Add README/documentation
-rw-r--r--doc/src/05100-lib-annotation.md15
l---------libimagannotation/README.md1
2 files changed, 16 insertions, 0 deletions
diff --git a/doc/src/05100-lib-annotation.md b/doc/src/05100-lib-annotation.md
new file mode 100644
index 0000000..a40842c
--- /dev/null
+++ b/doc/src/05100-lib-annotation.md
@@ -0,0 +1,15 @@
+## libimagannotation
+
+This library provides annotation functionality for entries.
+
+Annotations are normal Store entries, but their header at
+`annotation.is_annotation` is set to `true`.
+
+Annotations are linked to an entry (as in `libimagentrylink`).
+
+### Library functionality
+
+The library features two traits: One to extend an `Entry` with annotation
+functionality and another one for extending the `Store` with functionality to
+get annotations of an entry and all annotations in the store.
+
diff --git a/libimagannotation/README.md b/libimagannotation/README.md
new file mode 120000
index 0000000..5c4afa4
--- /dev/null
+++ b/libimagannotation/README.md
@@ -0,0 +1 @@
+../doc/src/05100-lib-annotation.md \ No newline at end of file