docs: done with documentation

Author: regisrex

README.md

@@ -1,68 +1,65 @@
-# **JSONDB**
-A simple database-like tool for nodejs using JSON for data storage  
+# **json-base**
+A simple json dbms with an orm, for nodejs, compatible with js and ts.
 ___
 
-
 ```bash
-$ npm install jsondb
+npm install -g json-base
 ```
 
-
-## 1. Features
-Generally, the point is that jsondb helps you perform databasa like transactions, currently CRUD. You can go there for sure here we go there this is the best choice.
+<br></br>
+Use json file as your database on the backend, json-base create the database json file for you and also provides you with a lightweight ORM to perform transactions on your database.
 
 ## 2. Get Started
 
-To get started, first make sure you have the latest stable version of nodejs on your computer. Another thing is that `jsondb` runs only in a node environemt.
+To get started, first make sure you have the latest stable version of nodejs on your computer. Another thing is that `json-base` runs only in a node environemt.
 
 
-**1. Install jsonbd dependecy with npm**  
+**1. Install json-base dependecy with npm**  
 
 You have to install jsondb with npm, it's not currently available on other package managers like yarn, etc.
 ```bash
-$ npm install jsondb
+$ npm install -g json-base
 ```
 
 **2. Initialize jsondb in your project**  
 
-Initialize jsondb in your project. If you have a `src` folder in your project, this will create a `jsondb/database.json` file in the src folder.
+Initialize jsondb in your project. Open the root folder of your project in your terminal and initialize json-base. This will create a `database.json` file in the project.
+
 ```bash
-$ npx jsondb --init
+$ json-base --init
 ```
 
 **3. Create your base schema or just leave it.**  
 
-Initialize jsondb in your project. If you have a `src` folder in your project, this will create a `jsondb/database.json` file in the src folder.  
-More about this can be found in the [tutorial](#2-get-started) section and in the [setting up jsondb in your project](#1-setting-up-jsondb-in-a-project) to be exact.
+Normally, the database.json created comes with 2 sample data collections, 'users' ans 'posts', you can add more collections as you please, it's allow.   
 
+**NB** : Respect the sythax of json files while adding new collection and also keep in mind that all collections must be enwrapped in the  `db`  field.
 <br>
 
+
 **4. Perform crud on the schemas as you need it**  
 
-Let's use a simple tutorial on how we can use this `jsondb`. We're going to create a simple app to interact with the `users` model where we can get all the  users, get a particular user with a unique key or get a group of users but not all. The developer can also get a limited number of users if he or she specifies the limit arguement in the get function. We're doing this in [tutorial](#3-a-simple-tutorial) section
+Let's have a simple tutorial on how we can use this `json-base`. We're going to create a simple app to interact with our models where we can get all the  users, get a particular user with a unique key or get a group of users but not all. The developer can also get a limited number of users if he or she specifies the limit arguement in the get function. We're doing this in [tutorial](#3-a-simple-tutorial) section
 
 ## 3. A simple tutorial 
 
 **Table of contents**  
-1. Setting up jsondb in a project
-2. Creating a base models
-3. Performing CRUD on the models
-4. Upcoming features
-
-#### 1. Setting up jsondb in a project
-In this section, we're going to start by creating a nodejs project and add and configure jsondb in it.  
-
-Let's start by installing jsondb from npm package manager 
+1. Getting data with get() api
+2. Deleting data with del() api
+3. Updating data with set() api
+4. Adding data with add() api
+
+#### 0. Setting up jsondb in a project
+Before starting to perform transactions to the database, let's 
+learn a little bit on the usage of the  CLI 
 ```
-$ npm install jsondb
-```
-
-Next, let's initialize jsondb in the nodejs project that we've created
+    Usage     : json-base [command]
+    Commands  :  
+                --init     Initialized the database.json in the current directory
+                --version  Prints the current version of json-base
+                --help     Prints the help message
 
 ```
-$ npx jsondb init
-```
-On this step, file called `database.json` will be created in the root folder.
 
 *database.json*
 ```json
@@ -93,132 +90,85 @@ On this step, file called `database.json` will be created in the root folder.
 You will need to remove the models in the json database as long as the sample ones may not match  with your purpose.
 
 #### 2. Getting data
-In this section, we're going to see how we can get data from our json database.
+In this section, we're going to see how we can get data from our json database.   
 ```ts
-
-    import { getData } from 'jsondb'
-    import UserType from './types/usertype'
-
-
-/*    1. Getting all the users   */
-
-    const allUsers  : UserType[]  =  await getData("users")
-    console.log(allUsers)      // prints the list of all users
-
- /*   2. Getting a user with a unique key   */
-
-    const  userWithId2 = await getData("users", { id : 2 })
-    console.log(userWithId2)     // prints the user with a unique id of 2
-
-/*    3. Limiting the number of users to retreive  */
-    const firstTenUsers =  await getData("users", {} , 10)
-    console.log(firstTenUsers)    // prints the first ten users in the json database 
-
+import { get } from 'json-base'
+  (async function(){
+       const aUsersWithId2  =  await get({
+              collection : "users",
+               where : {
+                     id : 2
+                   },
+               limit :  1
+           })
+  }())
 ```
-
+The code above retreives `1 record` from the `users` collection, where `user.id == 2`
 
 #### 3. Create data
 As said before, we'll be creating  a simple crud operation, this means that we already have read checked on our todo checklist as read is the same as getting data. Next we're going to work on creating data.
 ```ts
-    import { createData } from 'jsondb'
-    import UserType from './types/usertype'
-    
-    const newUser : UserType = {
-        id : 4 ,
-        username : "delba",
-        email : "[email protected]",
-        password : "8ui4gi82k4kj889n"
-    }
-
-    createData("users" ,{ data : newUser }, (err , user) => {
-        if(err){
-            console.log(err.message)
-            process.exit(0)
-           }
-        console.log(user)
-    })
-
-    /*  It's also possible to add an array of users, jsondb api can handle that too */
-
-    const unsavedUsers  : UserType[] = [
-        {
-            id : 4 ,
-            username : "tim",
-            email : "[email protected]",
-            password : "3456yojp%7-055"
-        }, 
-        {
-            id : 5 ,
-            username : "palmer",
-            email : "[email protected]",
-            password : "uhnui0no082kn9"
+  import  { add } from 'json-base'
+  (async function(){
+      await add({
+        collection : "posts",
+        data : {
+            id  : 1 ,
+            userId : 1 ,
+            photo :  "https://linkto.img",
+            caption : "The quick brown fox"
         }
-    ]
-
-    createData("users" , { data : unsavedUsers }  , (err , users) => {
-         if(err){
-            console.log(err.message)
-            process.exit(0)
-           }
-        console.log(users)
     })
+  }())
 ```
-
+The code snipped above adds the `data ` object in the `posts` collection 
 
 #### 4. Update and delete data
 
 Let's combine the update and  the delete  sections into one section as long as they're kinda simple and easy to understand.
 
 Updating data will require a unique identifier of the record we're updating.
 ```ts
-import { updateData } from "jsondb"
-import { Request , Response } from "@types/node"
-import UserType from "./types/usertype"
-
-app.put("/updateUser/:id" , async (req : Request ,res) => {
-    const userId = req.params.id
-    const { username } = req.body
-    const updatedUser = await updateData("users" , {
-        // update user wher the id equals to userId
+   import { set } from 'json-base'
+   await set({
+        collection : "users",
         where : {
-            id : userId
+            username : "leerob"
         },
-        //  update the user with a new username
         data : {
-            username
+            email : "[email protected]"
         }
     })
-
-})
 ```
 
 Enough for updating data, the next is to learn how to delete some records from the json database. Here, a unique identifier is required.
 
 ```ts
+ import { del } from 'json-base'
+  
+  (async function(){
+       await del({
+           collection  : "posts",
+           where : {
+                  id : 1 
+               }     
+       })
+  }())
+```
 
-import { deleteData } from "jsondb"
-import UserType from "./types/usertype"
-
-deleteData("users" , { id : 2 } , (err,data) => {
-    if(err){
-        console.log("Uncaught error " , err)
-        process.exit(0)
-    }
-    console.log(data)
-} )
+🎉 Congrats! Now we've finished creating our CRUD operations on the users model or collection and I hope now you're able to consume our API and make your life easier.  
+*For more, jsdoc was used , hover on your imported function to see the documentation*
 
-```
 
-🎉 Congrats! Now we've finished creating our CRUD operations on the users model or collection and I hope now you're able to consume our API and make your life easier. 
 ## Contributing
 Willing to contribute to this Open Source project ?
 You can contribute to this project by **making bug reports** , **requesing feautures** ,  **Adding features** and more other ways. Read more  [here](./CONTRIBUTING.md) before contributing.
 
 ## Maintainers
-This project is built and maintained by [@ndzhwr](https://twitter.com/ndzhwr).
+This repo is  maintained by [@ndzhwr](https://github.com/ndzhwr).
 
 ## Licence
-This project is [MIT]() licenced.
+This project is [MIT](LICENCE) licenced.
 ___
 
 <p align="right">⁕ <a href="https://github.com/ndzhwr/works">ndzhwr-works</a> 2023. </p>