branch: externals/taxy
commit 21e6fa6986e8d6452836ee3d86eb1ca676f744ad
Author: Adam Porter <a...@alphapapa.net>
Commit: Adam Porter <a...@alphapapa.net>
Docs: Commentary, header
---
taxy.el | 22 ++++++++++++++++++++--
1 file changed, 20 insertions(+), 2 deletions(-)
diff --git a/taxy.el b/taxy.el
index 44fb4e3..74bf064 100644
--- a/taxy.el
+++ b/taxy.el
@@ -3,7 +3,7 @@
;; Copyright (C) 2021 Adam Porter
;; Author: Adam Porter <a...@alphapapa.net>
-;; Keywords:
+;; Keywords: lisp
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
@@ -20,7 +20,25 @@
;;; Commentary:
-;;
+;; This library provides a programmable way to classify arbitrary
+;; objects into a hierarchical taxonomy. (That's a lot of fancy words
+;; to say that this lets you put things in nested groups.)
+
+;; Helpful features include:
+
+;; + Dynamic taxonomies: Objects may be classified into hierarchies
+;; automatically defined at runtime based on their attributes.
+
+;; + Reusable taxonomies: Taxonomy definitions may be stored in
+;; variables and reused in other taxonomies' descendant groups.
+
+;; Basic usage:
+
+;; 1. Make a taxy with `make-taxy'.
+;; 2. Fill the taxy with objects using `taxy-fill'.
+;; 3. For a simple display of a taxy's objects, use `taxy-plain'.
+
+;; For more details, please see the README.org file.
;;; Code:
