From ea517dc6bd5f39da7d569bdd82910ba89340d1f6 Mon Sep 17 00:00:00 2001
From: olemorud <ole.kristian.morud@cern.ch>
Date: Sat, 22 Apr 2023 20:57:38 +0200
Subject: [PATCH] Add README

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f3d6c58
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+
+# C JSON Parser
+
+Just for fun.
+
+Parses json values into structs containing type information and data.
+Arrays are null-terminated arrays of pointers to json values.
+Objects are represented with a poorly written map implementation.
+Remaining data types are represented with native C types.
+
+# Usage
+
+##  Compile
+
+**option 1** build (debug build):
+```sh
+make
+```
+
+**option 2** build (release build):
+```sh
+make BUILD=release
+```
+
+## Run
+
+```sh
+./bin/{release|debug}/json_parser
+```
+