From f39fede52a62dd3776b080fc7da3f4dc031cb2ac Mon Sep 17 00:00:00 2001
From: nyx <carsten@kragelund.me>
Date: Sat, 17 Jun 2023 05:42:42 +0200
Subject: [PATCH] Add README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..da1adbe
--- /dev/null
+++ b/README.md
@@ -0,0 +1,23 @@
+# HCFG
+
+HCFG is a configuration format meant to be usable without sacrificing familiarity, it does this by expanding on the syntax of JSON, allowing for extra features such as
+* Trailing commas
+* Comments
+* Binary data
+* Unquoted keys
+
+## Example
+
+```hcfg
+{
+    // test
+    key: "value",
+    /* this is a comment */
+    other_key: 100,
+    floating: 123f,
+    other_float: 123.3,
+    bin: b"test",
+    arr: [1,2],
+    nested: { key: "not trailing" },
+}
+```
\ No newline at end of file