From 0f0afb72a1d92a77337f8fe920ea800cf5693a07 Mon Sep 17 00:00:00 2001
From: Sara <sara@saragerretsen.nl>
Date: Wed, 13 Sep 2023 15:08:26 +0000
Subject: [PATCH] Added README

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5e513e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+# Kwil Header tool
+An in-development command line tool for generating serialization code from C header files.
+
+Features:
+[x] Generate `*_json_length` and `*_to_json`functions for structs and enums marked with `KWIL_STRUCT()` or `KWIL_ENUM()`
+[ ] Generate `*_from_json` functins for structs.
+[ ] Dynamic array length specifiers (e.g: `KWIL_FIELD(LEN=13` or `KWIL_FIELD(LEN=<field_name>`)
+
+## Example
+```c
+#include "kwil.h" // kwil.h header contains empty KWIL_STRUCT() KWIL_ENUM() and KWIL_FIELD() macros
+
+```
\ No newline at end of file