branch: externals/setup
commit 295e1736f7ebbf0813c74d8623421bff6b3f078c
Author: Philip K <phil...@posteo.net>
Commit: Philip K <phil...@posteo.net>
Update README
---
README.md | 19 ++++++++++++++-----
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 9e25927..760ea4f 100644
--- a/README.md
+++ b/README.md
@@ -50,9 +50,18 @@ will be replaced with the functional equivalent of
Additional "keywords" can be defined using `setup-define'. All known
keywords are documented in the docstring for `setup'.
-**Note:** This package is still being developed, and will probably
-change a lot. See [this thread][thread] from emacs-devel for more
-information.
+Installation
+------------
+
+`setup.el` is part of [GNU ELPA][elpa], and can be installed using
+`package.el`.
+
+Usage
+-----
+
+The `setup` macro is autoloaded, and can be used directly. The code
+generated by `setup` does not depend on `setup.el`, meaning that your
+initialization file can be byte-compiled more efficiently.
Bugs
----
@@ -64,10 +73,10 @@ assignment][ca] to the FSF.
Copying
-------
-`setup.epl` is distributed under the [CC0 1.0 Universal (CC0 1.0)
+`setup.el` is distributed under the [CC0 1.0 Universal (CC0 1.0)
Public Domain Dedication][cc0] license.
-[thread]: https://lists.gnu.org/archive/html/emacs-devel/2021-02/msg00188.html
+[elpa]: http://elpa.gnu.org/packages/setup.html
[mail]: https://lists.sr.ht/~zge/public-inbox
[ca]:
https://www.gnu.org/software/emacs/manual/html_node/emacs/Copyright-Assignment.html#Copyright-Assignment
[cc0]: https://creativecommons.org/publicdomain/zero/1.0/deed
