From 0722c8cda791535da0b6847bff92e13129a5490f Mon Sep 17 00:00:00 2001
From: Charles Sharma <___@___.___>
Date: Sat, 16 Jul 2022 14:30:44 -0600
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..5ca0f5a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+# jsondb
+
+`jsondb` is a way to use JSON as a NoSQL database. It uses an ORM and is the only way to interact with the database.
+
+## Loading a database
+
+All you need to do is to use `loadDB`. Here is an example:
+
+```javascript
+let { loadDB } = require("jsondb");
+let db = loadDB("db.json");
+```
+
+## Setting values
+
+You do it just like any JavaScript object. Here is an example:
+
+```javascript
+db["bits"] = 64;
+db.bits = 64; // this also works
+```
+
+## Getting values
+
+Again, it's just like any JS object. Here is an example:
+
+```javascript
+let bits = db["bits"];
+bits = db.bits; // that also works
+```