inibase 1.0.0-rc.0 → 1.0.0-rc.10

package/README.md

@@ -1,26 +1,27 @@
-![Inibase banner](./.github/assets/banner.jpg)
+[![Inibase banner](./.github/assets/banner.jpg)](https://github.com/inicontent/inibase)
 
-# Inibase
+# Inibase :pencil:
 
-[![npmjs](https://img.shields.io/npm/dm/inibase.svg?style=flat)](https://www.npmjs.org/package/inibase) [![Node.js Version](https://img.shields.io/badge/node-18.11.0-blue)](https://nodejs.org/) [![License](https://img.shields.io/github/license/inicontent/inibase.svg?style=flat&colorA=18181B&colorB=28CF8D)](./LICENSE) [![Activity](https://img.shields.io/github/commit-activity/m/inicontent/inibase)](https://github.com/inicontent/inibase/pulse) [![GitHub stars](https://img.shields.io/github/stars/inicontent/inibase?style=social)](https://github.com/inicontent/inibase)
+[![npmjs](https://img.shields.io/npm/dm/inibase.svg?style=flat)](https://www.npmjs.org/package/inibase) [![License](https://img.shields.io/github/license/inicontent/inibase.svg?style=flat&colorA=18181B&colorB=28CF8D)](./LICENSE) [![Activity](https://img.shields.io/github/commit-activity/m/inicontent/inibase)](https://github.com/inicontent/inibase/pulse) [![GitHub stars](https://img.shields.io/github/stars/inicontent/inibase?style=social)](https://github.com/inicontent/inibase)
 
 > File-based relational database, simple to use and can handle large data :fire:
 
 ## Features
 
-- **Lightweight** 🪶 (~50kb)
+- **Lightweight** 🪶 (~80kb)
 - **Minimalist** :white_circle:
 - **TypeScript** :large_blue_diamond:
 - **Super-Fast** :turtle:
 - **Suitable for large data** :page_with_curl:
 - **Safe** :lock:
+- **Easy to use** :hourglass:
 - **...** and much more :rocket:
 
 ## Usage
 
 ```js
 import Inibase from "inibase";
-const db = new Inibase("/database_name");
+const db = new Inibase("database_name");
 
 // Get all items from "user" table
 const users = await db.get("user");
@@ -29,12 +30,12 @@ const users = await db.get("user");
 const users = await db.get("user", undefined, { page: 2, per_page: 15 });
 
 // Get only required columns to improve speed
-const users = await InibaseDB.get("user", undefined, {
-  columns: ["username", "address.street", "hobbies.*.name"],
+const users = await db.get("user", undefined, {
+  columns: ["username", "address.street", "hobbies.name"],
 });
 
 // Get items from "user" table where "favoriteFoods" does not includes "Pizza"
-const users = await InibaseDB.get("user", { favoriteFoods: "![]Pizza" });
+const users = await db.get("user", { favoriteFoods: "![]Pizza" });
 ```
 
 If you like Inibase, please sponsor: [GitHub Sponsors](https://github.com/sponsors/inicontent) || [Paypal](https://paypal.me/KarimAmahtil).
@@ -49,19 +50,17 @@ Become a sponsor and have your company logo here 👉 [GitHub Sponsors](https://
 ## Install
 
 ```js
-// npm
-npm install inibase
+<npm|pnpm> install inibase
+```
 
-// pnpm
-pnpm add inibase
+## How it works?
 
-// yarn
-yarn add inibase
-```
+To semplify the idea, each database has tables, each table has columns, each column will be stored in a seperated file. When POSTing new data, it will be appended to each columns file as new line. When GETing data, the file will be readed line-by-line so it can handle large data (without consuming a lot of resources)
 
 ## Examples
 
-#### POST
+<details>
+<summary>POST</summary>
 
 ```js
 import Inibase from "inibase";
@@ -268,7 +267,10 @@ const product = await db.post("product", product_data);
 // ]
 ```
 
-#### GET
+</details>
+
+<details>
+<summary>GET</summary>
 
 ```js
 import Inibase from "inibase";
@@ -336,9 +338,17 @@ const users = await db.get("user", { favoriteFoods: "[]Pizza" });
 //   },
 //   ...
 // ]
+
+// Get all "user" columns except "username" & "address.street"
+const users = await db.get("user", undefined, {
+  columns: ["!username", "!address.street"],
+});
 ```
 
-#### PUT
+</details>
+
+<details>
+<summary>PUT</summary>
 
 ```js
 import Inibase from "inibase";
@@ -354,7 +364,10 @@ await db.put("user", { isActive: false }, "1d88385d4b1581f8fb059334dec30f4c");
 await db.put("user", { isActive: false }, { isActive: true });
 ```
 
-#### DELETE
+</details>
+
+<details>
+<summary>DELETE</summary>
 
 ```js
 import Inibase from "inibase";
@@ -370,45 +383,7 @@ await db.put("user", "1d88385d4b1581f8fb059334dec30f4c");
 await db.put("user", { isActive: false });
 ```
 
-## Typescript
-
-#### Schema
-
-```js
-type FieldType =
-  | "string"
-  | "number"
-  | "boolean"
-  | "date"
-  | "email"
-  | "url"
-  | "table"
-  | "object"
-  | "array";
-type Field =
-  | {
-      id?: string | number | null | undefined,
-      key: string,
-      type: Exclude<FieldType, "array" | "object">,
-      required?: boolean,
-    }
-  | {
-      id?: string | number | null | undefined,
-      key: string,
-      type: "array",
-      required?: boolean,
-      children: FieldType | FieldType[] | Schema,
-    }
-  | {
-      id?: string | number | null | undefined,
-      key: string,
-      type: "object",
-      required?: boolean,
-      children: Schema,
-    };
-
-type Schema = Field[];
-```
+</details>
 
 ## Roadmap
 
@@ -417,7 +392,7 @@ type Schema = Field[];
     - [x] Pagination
     - [x] Criteria
     - [x] Columns
-    - [ ] Order
+    - [ ] Order By
   - [x] POST
   - [x] PUT
   - [x] DELETE
@@ -431,9 +406,17 @@ type Schema = Field[];
   - [x] Table
   - [x] Object
   - [x] Array
-  - [ ] Password
-  - [ ] IP
-- [ ] Suggest [new feature +](https://github.com/inicontent/inibase/discussions/new?category=ideas)
+  - [x] Password
+  - [x] IP
+  - [x] HTML
+  - [x] Id
+- [ ] TO-DO:
+  - [ ] Improve caching
+  - [ ] Commenting the code
+- [ ] Features:
+  - [ ] Encryption
+  - [ ] Compress data
+  - [ ] Suggest [new feature +](https://github.com/inicontent/inibase/discussions/new?category=ideas)
 
 ## License