From 97aa8291fac3b27aad5d9a7d2f3aeaf2c2710f22 Mon Sep 17 00:00:00 2001
From: Matei Adriel <rafaeladriel11@gmail.com>
Date: Tue, 15 Jan 2019 21:19:16 +0200
Subject: [PATCH] javascript(mongy): added readme

Signed-off-by: prescientmoon <git@moonythm.dev>
---
 javascript/mongy/README.md | 54 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)
 create mode 100644 javascript/mongy/README.md

diff --git a/javascript/mongy/README.md b/javascript/mongy/README.md
new file mode 100644
index 0000000..526f726
--- /dev/null
+++ b/javascript/mongy/README.md
@@ -0,0 +1,54 @@
+# Mongy
+A high level interface for MongoDB built on top of Mongoose
+
+
+#Get started:
+
+To get started, first install the package:
+```
+npm install mongy
+```
+Then you need to include it in your script:
+```
+const Mongy = require("mongy");
+```
+
+The next step is to create an instance of the Mongy class:
+```
+const mydb = new Mongy();
+```
+
+To connect to your datebase you need to call the (async) 'connect' method:
+```
+mydb.connect(process.env.DBURL);
+```
+
+To create your first model call createModel(name,collection,schema):
+```
+mydb.createModel("User","users",{
+  name:String,
+  email:String
+});
+```
+
+To make an instance of the model call 'instantiate(name,data)':
+```
+async function addUser(name,email){
+  const myNewUser = mydb.instantiate("User",{name,email});
+}
+```
+
+And then to save your model call the (async) function 'saveModel':
+```
+async function addUser(name,email){
+  ...
+  await mydb.saveModel(myNewUser);
+}
+```
+
+Then you can get the data of your user via the '.find(name,data)' method:
+```
+async function getUsers(name){
+  return await mydb.find("User",{name});
+}
+```