From 57c7231dc15ec1e2e26a1fcaa33d32eeb99c69d8 Mon Sep 17 00:00:00 2001
From: Rodolfo Barcelli Jo <rodolfo.barcelli@gmail.com>
Date: Thu, 22 Jan 2026 22:36:50 +0800
Subject: [PATCH] Add: Central README.md

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..86bea45
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# Barcelli Entity-Component-System (BECS)
+
+This is an header only library implementing a Entity-Component-System in C89 using memory arenas. You can look at tests/main.c for an example of an implementation. This is an educational library, done in my free time. If you are interested in improving the design of this ECS, feel free to submit a pull request.
+
+## Instructions on Usage
+
+Include `becs.h` and in exactly one file define `BECS_IMPLEMENTATION` before the include.
+
+To setup your Maximum Entity Count and Maximum component count, define `BECS_MAX_ENTITIES` and `BECS_MAX_COMPONENTS` before including `becs.h`
+
+Example:
+
+```c
+#define BECS_MAX_ENTITIES 100
+#define BECS_MAX_COMPONENTS 10
+
+#define BECS_IMPLEMENTATION
+#include <becs.h>
+
+int main(void)
+{
+    /* your program goes here */
+}
+```
+
+## Systems