status-im
/
edn.nim
mirror of https://github.com/status-im/edn.nim.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

added README

This commit is contained in:
Roland Sadowski 2019-08-23 19:02:47 +01:00
parent 81c2dea208
commit 72e24c489e
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
README.md Normal file
View File

@ -0,0 +1,27 @@
# EDN
A Clojure and EDN parser library written in Nim.
This library should be considered alpha quality at this point.
* API will change
* Some design dead-ends still in the code
* I'm learning Nim at the same time as I'm writing this
## Motivation
* To be able to parse EDN files and also Clojure/ClojureScript code.
* If you decide to read the source you may wonder what's the weird
comment handling code is for? The answer: I'd like to be able to
put meaningful stuff in the comments to enable literate programming
(or at least experiment with it), which means I don't want to always
discard the them.
## Code Style
I'm using what Python people use: lowercase with underscores for `procs`
and Capitalized names for types.
# License
EPL 2.0