branch: externals/marginalia
commit c2cb26303002bf8ab756d8c82d7abc2b03f02424
Author: iyefrat <itai3...@gmail.com>
Commit: GitHub <nore...@github.com>
Add short usage section to the README (#108)
Fix #86
---
README.org | 9 +++++++++
1 file changed, 9 insertions(+)
diff --git a/README.org b/README.org
index 94d3979..cbd1c03 100644
--- a/README.org
+++ b/README.org
@@ -55,6 +55,15 @@ commands.
(marginalia-mode))
#+end_src
+* Usage
+The annotations for elisp symbols include their symbol class. For more
+information on what the different classifications mean, see the docstring of
+~marginalia--symbol-class~.
+
+In general, to learn more about what different annotations mean, a good
starting
+point is to look at ~marginalia-annotator-registry~, and follow up to the
+annotation function of whatever category you are interested in.
+
* Adding custom annotators or classifiers
Commands that support minibuffer completion use a completion table of all the
