branch: elpa/parseclj
commit acf4a29778cca91182ec84c5a3a2f9845edf438f
Author: Bozhidar Batsov <[email protected]>
Commit: Bozhidar Batsov <[email protected]>
Update the README
---
README.md | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index cabc9ea817..7d095555a9 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,21 @@
# EDN reader and Clojure parser for Emacs Lisp
-WIP
+`parseclj` is an Emacs Lisp library for parsing Clojure code and EDN data. It
+supports several input and output formats, all powered by the same shift-reduce
+parser function.
+
+Take a look at the [design document](DESIGN.md) for more details.
+
+`parseclj` is in **alpha** state right now.
+
+## Installation
+
+TODO
+
+## Usage
+
+TODO
## License
