add README.md file

Signed-off-by: mario <[email protected]>
MarioBassem · Nov 11, 2023 · 4041e6c · 4041e6c
1 parent 36a32c2
commit 4041e6c
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,9 @@
+# JSON Parser
+
+This is a json parser package. I build it just for learning purposes.
+
+Only exported function is `Parse(b []byte)`. It parses json text and returns a `map[string]interface{}` and an error if any.
+
+- All numbers are treated as `float64` numbers.
+- Arrays are fed into a list of interafces `[]interface{}`
+- Objects are fed into a `map[string]interface{}`