From 92b21e0ad39b3776b6af77b1be624207561b43fe Mon Sep 17 00:00:00 2001
From: JOLIMAITRE Matthieu <matthieu@imagevo.fr>
Date: Wed, 29 May 2024 04:05:02 +0200
Subject: [PATCH] add readme

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

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..99405d0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,18 @@
+# Debilus
+
+Easy to setup typed relational Wrapper atop deno KV.
+
+## Usage
+
+```ts
+import { EntryFor, Schema, Store } from "https://git.barnulf.net/mb/debilus/raw/commit/fc701bec680dd73be29c72164f47ee87fac540c7/mod.ts"
+const store = await Store.open(
+    new Schema({
+        user: { name: "string" },
+        post: { author: ["one", "user"] }
+    }),
+    "./store.kv"
+);
+type User = EntryFor<typeof store, "user">;
+const bob: User = await store.insert("user", { name: "bob" });
+```