Merge pull request #5 from ariflogs/dev

added useage

Author: ariflogs

README.md

@@ -1,3 +1,5 @@
+## SQL-to-NOSQL
+
 As the name suggests, **sql-to-nosql** lets you run SQL scripts on your NoSQL database.
 
 ## Status
@@ -14,6 +16,32 @@ The project is under active development and is not yet ready to use in productio
 npm insall sql-to-nosql
 ```
 
+### Usage
+```js
+
+  import { SqlToNoSql } from 'sql-to-nosql';
+
+  const runner = new SqlToNoSql({
+    srcDBtype: "postgresql",
+    destDBtype: "mongodb",
+    connection: "YOUR_DIST_DB_CONNECTION_STRING"
+  });
+
+  const resp = await runner.run("select * from users where email = devarifhossain@gmail.com");
+
+  console.log(resp);   
+  /** ☝️ [{
+    _id: new ObjectId("622f07d56852c662cb8b953b"),
+    role: 'admin',
+    name: 'Arif Hossain',
+    email: 'devarifhossain@gmail.com',
+    __v: 0
+  }]*/
+
+```
+
+
+
 ### Roadmap
 
 - [ ] Database
@@ -55,3 +83,4 @@ npm insall sql-to-nosql
   - [ ] LIKE
   - [ ] IS NULL
   - [ ] IS NOT NULL
+- [ ] Typescript Support

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "sql-to-nosql",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Run SQL quries on your Mongodb database.",
   "repository": {
     "type": "git",
@@ -9,20 +9,30 @@
   "homepage": "https://github.com/ariflogs/SQL-to-NoSQL",
   "main": "dist/index.js",
   "scripts": {
+    "dev": "tsc -w",
     "start": "tsc && node dist/index.js",
     "build": "npx prettier . --check && tsc",
     "test": "echo \"Error: no test specified\" && exit 1",
     "pretty": "npx prettier . --write"
   },
-  "author": "Arif Hossain",
+  "author": {
+    "name": "Arif Hossain",
+    "email": "devarifhossain@gmail.com",
+    "url": "https://ariflogs.com"
+  },
+  "keywords": [
+    "ORM",
+    "SQL",
+    "NoSQL",
+    "SQL to NoSQL"
+  ],
   "license": "MIT",
   "devDependencies": {
     "prettier": "3.0.3",
     "typescript": "^5.2.2"
   },
   "dependencies": {
-    "mongodb": "^6.1.0",
-    "sql-to-nosql": "^0.0.3"
+    "mongodb": "^6.1.0"
   },
   "type": "module"
-}
+}