chore(): add readme and license

silmeth · Oct 13, 2017 · 80862e4 · 80862e4
1 parent 3044d17
commit 80862e4
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 0 deletions.
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,13 @@
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+                   Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified
+copies of this license document, and changing it is allowed as long
+as the name is changed.
+
+           DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+  TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+ 0. You just DO WHAT THE FUCK YOU WANT TO.WANT TO.
diff --git a/README.md b/README.md
@@ -0,0 +1,8 @@
+## json-parser – a simple example JSON parser in Kotlin with [better-parse](https://github.com/h0tk3y/better-parse)
+
+The whole parsing code is in [SimpleJsonGrammar](src/main/kotlin/com/github/silmeth/SimpleJsonGrammar.kt) object,
+there are also a few [tests](src/test/kotlin/com/github/silmeth/SimpleJsonGrammarTest.kt) showing it works.
+
+It does not currently handle unicode escape characters (like `"\uFDFD"` for `﷽` string).
+
+Tests can be run with `./gradlew test`.