branch: elpa/annotate commit 0bd3bdce01aafb379140681410f185f42d4f43f1 Author: Bastian Bechtold <bb@Mr-Bigglesworth.local> Commit: Bastian Bechtold <bb@Mr-Bigglesworth.local>
improved README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ed835aff93..16e9fe8bcd 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ Annotate.el =========== -A minor mode that can add non-destructive annotations to any file. When `annotate-mode` is active, `C-c C-a` will create, edit, or delete annotations. +This package provides a minor mode `annotate-mode`, which can add annotations to arbitrary files without changing the files themselves. This is very useful for code reviews. When `annotate-mode` is active, `C-c C-a` will create, edit, or delete annotations.  With an active region, `C-c C-a` creates a new annotation for that region. With no active region, `C-c C-a` will create an annotation for the word under point. If point is on an annotated region, `C-c C-a` will edit that annotation instead of creating a new one. Clearing the annotation deletes them. +All annotations are saved in `annotate-file` (`~/.annotations` by default). + This package is released under the MIT license.