branch: elpa/parseclj
commit 3e48aa7b40e53607e236f70a0b1331875752e284
Author: Daniel Barreto <[email protected]>
Commit: Daniel Barreto <[email protected]>
Remove mentions to parseedn in README.md
---
README.md | 35 +++++------------------------------
1 file changed, 5 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index 1b930c937e..bcadcf9eb1 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
[](https://travis-ci.org/clojure-emacs/parseclj)
-# EDN reader and Clojure parser for Emacs Lisp
+# Clojure parser for Emacs Lisp
`parseclj` is an Emacs Lisp library for parsing Clojure code and [EDN
data](https://github.com/edn-format/edn). It supports several input and output
@@ -25,12 +25,9 @@ You can just copy-paste this code into your Emacs init file:
## Usage
-`parseclj` is actually a compound of two libraries:
-
-- `parseedn`: An EDN reader that transforms EDN to Emacs Lisp data structures.
-- `parseclj`: A Clojure parser that returns an
- [AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) that, for example,
- given as input `(1 2 [:a :b :c])`, it looks like this:
+`parseclj` contains function that return an
+[AST](https://en.wikipedia.org/wiki/Abstract_syntax_tree) that, for example,
+given as input `(1 2 [:a :b :c])`, it looks like this:
``` emacs-lisp
((:node-type . :root)
@@ -61,7 +58,7 @@ You can just copy-paste this code into your Emacs init file:
(:value . :c))))))))
```
-In order to use any of them, you first need to require it:
+In order to use any of these functions, you first need to require it:
```emacs-lisp
(require 'parseclj)
@@ -71,8 +68,6 @@ In order to use any of them, you first need to require it:
And then you will have the following functions at your disposal:
-### parseclj
-
- `parseclj-parse-clojure` &rest string-and-options
When no arguments, parses Clojure source code into an AST and returns it.
@@ -107,26 +102,6 @@ And then you will have the following functions at your
disposal:
Transfrom the given AST into Clojure source code and returns it as a
string.
-### parseedn
-
-- `parseedn-read`
-
- Read content from the current buffer as EDN and transforms it into an Emacs
- Lisp value.
-
-- `parseedn-read-str` str
-
- Read STR as EDN and transfroms it into an Emacs Lisp value.
-
-- `parseedn-print` datum
-
- Inserts DATUM as EDN Into the current buffer. DATUM can be any Emacs Lisp
- value.
-
-- `parseedn-print-str` datum
-
- Returns a string containing DATUM as EDN. DATUM can be any Emacs Lisp
- value.
## License