Add README/documentation

This commit is contained in:
Matthias Beyer 2017-06-26 19:23:19 +02:00
parent 1b88c22dec
commit 9583ae06cd
2 changed files with 16 additions and 0 deletions

View file

@ -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.

1
libimagannotation/README.md Symbolic link
View file

@ -0,0 +1 @@
../doc/src/05100-lib-annotation.md