docs: add sponsors section

Alwatr · Sep 24, 2024 · 67c9332 · 67c9332
1 parent 4ace464
commit 67c9332
Show file tree

Hide file tree

Showing 7 changed files with 204 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -74,6 +74,12 @@ const myPost = await alwatrStore.openDocument(docId);
 
 Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
 
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
 ## License
 
 This project is licensed under the AGPL-3.0 License.

diff --git a/packages/engine/README.md b/packages/engine/README.md
@@ -74,6 +74,12 @@ const myPost = await alwatrStore.openDocument(docId);
 
 Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
 
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
 ## License
 
 This project is licensed under the AGPL-3.0 License.

diff --git a/packages/helper/README.md b/packages/helper/README.md
@@ -1,5 +1,89 @@
-# Alwatr Nitrobase
+# Nitrobase
 
-Extremely fast and compact JSON-based database that operates in memory, includes a JSON file backup, and serve over the highly accelerated Nginx.
+**Extremely Fast and Compact JSON-Based In-Memory Database with Nginx Integration**
 
-## for more information please visit [Alwatr Nitrobase](https://github.com/Alwatr/nitrobase#readme)
+Nitrobase is a blazingly fast, lightweight database built on JSON. It stores data entirely in memory for lightning-quick access, while also providing a JSON file backup for persistence. You can easily serve your data over the web using our high-performance accelerated Nginx server.
+
+## Key Features
+
+* **In-Memory Performance:** All data is stored in RAM, ensuring extremely fast reads and writes.
+* **JSON Simplicity:** Data is stored and managed in a straightforward JSON format.
+* **File Backup:** Automatic JSON file backup ensures data persistence.
+* **Nginx Integration:** Seamlessly serve your data over the web using accelerated Nginx.
+* **Compact Storage:** Efficient storage format minimizes disk space usage.
+
+## Installation
+
+```bash
+npm install @alwatr/nitrobase
+```
+
+## Getting Started
+
+### Create a Collection
+
+```js
+import { AlwatrNitrobase, Region } from '@alwatr/nitrobase';
+
+const alwatrStore = new AlwatrNitrobase({
+  rootPath: './db',
+  defaultChangeDebounce: 2_000, 
+});
+
+const postsCollectionId = {
+  name: 'post',
+  region: Region.PerUser,
+  ownerId: 'user_123',
+  schemaVer: 2,
+};
+
+alwatrStore.newCollection(postsCollectionId);
+
+const postsCollection = await alwatrStore.openCollection(postsCollectionId);
+
+postsCollection.addItem('post1', {
+  title: 'My First Post',
+  content: 'This is the content of my first post.'
+});
+```
+
+### Create a Document
+
+```js
+import { AlwatrNitrobase, Region } from '@alwatr/nitrobase';
+
+const alwatrStore = new AlwatrNitrobase({
+  rootPath: './db',
+  defaultChangeDebounce: 2_000, 
+});
+
+const docId = {
+  name: 'posts/my-first-post',
+  region: Region.Authenticated,
+};
+
+alwatrStore.newDocument(docId, {
+  title: 'My First Post',
+  content: 'This is the content of my first post.'
+});
+
+const myPost = await alwatrStore.openDocument(docId);
+```
+
+## Demo Code
+
+Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
+
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
+## License
+
+This project is licensed under the AGPL-3.0 License.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
diff --git a/packages/nginx/README.md b/packages/nginx/README.md
@@ -1,5 +1,89 @@
-# Alwatr Nitrobase Nginx
+# Nitrobase
 
-Extremely fast and compact JSON-based database that operates in memory, includes a JSON file backup, and serve over the highly accelerated Nginx.
+**Extremely Fast and Compact JSON-Based In-Memory Database with Nginx Integration**
 
-## for more information please visit [Alwatr Nitrobase](https://github.com/Alwatr/nitrobase#readme)
+Nitrobase is a blazingly fast, lightweight database built on JSON. It stores data entirely in memory for lightning-quick access, while also providing a JSON file backup for persistence. You can easily serve your data over the web using our high-performance accelerated Nginx server.
+
+## Key Features
+
+* **In-Memory Performance:** All data is stored in RAM, ensuring extremely fast reads and writes.
+* **JSON Simplicity:** Data is stored and managed in a straightforward JSON format.
+* **File Backup:** Automatic JSON file backup ensures data persistence.
+* **Nginx Integration:** Seamlessly serve your data over the web using accelerated Nginx.
+* **Compact Storage:** Efficient storage format minimizes disk space usage.
+
+## Installation
+
+```bash
+npm install @alwatr/nitrobase
+```
+
+## Getting Started
+
+### Create a Collection
+
+```js
+import { AlwatrNitrobase, Region } from '@alwatr/nitrobase';
+
+const alwatrStore = new AlwatrNitrobase({
+  rootPath: './db',
+  defaultChangeDebounce: 2_000, 
+});
+
+const postsCollectionId = {
+  name: 'post',
+  region: Region.PerUser,
+  ownerId: 'user_123',
+  schemaVer: 2,
+};
+
+alwatrStore.newCollection(postsCollectionId);
+
+const postsCollection = await alwatrStore.openCollection(postsCollectionId);
+
+postsCollection.addItem('post1', {
+  title: 'My First Post',
+  content: 'This is the content of my first post.'
+});
+```
+
+### Create a Document
+
+```js
+import { AlwatrNitrobase, Region } from '@alwatr/nitrobase';
+
+const alwatrStore = new AlwatrNitrobase({
+  rootPath: './db',
+  defaultChangeDebounce: 2_000, 
+});
+
+const docId = {
+  name: 'posts/my-first-post',
+  region: Region.Authenticated,
+};
+
+alwatrStore.newDocument(docId, {
+  title: 'My First Post',
+  content: 'This is the content of my first post.'
+});
+
+const myPost = await alwatrStore.openDocument(docId);
+```
+
+## Demo Code
+
+Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
+
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
+## License
+
+This project is licensed under the AGPL-3.0 License.
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit issues and pull requests.
diff --git a/packages/nitrobase/README.md b/packages/nitrobase/README.md
@@ -74,6 +74,12 @@ const myPost = await alwatrStore.openDocument(docId);
 
 Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
 
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
 ## License
 
 This project is licensed under the AGPL-3.0 License.

diff --git a/packages/reference/README.md b/packages/reference/README.md
@@ -74,6 +74,12 @@ const myPost = await alwatrStore.openDocument(docId);
 
 Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
 
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
 ## License
 
 This project is licensed under the AGPL-3.0 License.

diff --git a/packages/types/README.md b/packages/types/README.md
@@ -74,6 +74,12 @@ const myPost = await alwatrStore.openDocument(docId);
 
 Explore the provided demo code (`collection.mjs`, `document.mjs`, `benchmark.mjs`) to see Alwatr Nitrobase in action and gain a deeper understanding of its capabilities.
 
+## Sponsors
+
+The following companies, organizations, and individuals support Nitrobase ongoing maintenance and development. Become a Sponsor to get your logo on our README and website.
+
+[![Exir Studio](https://avatars.githubusercontent.com/u/181194967?s=200&v=4)](https://exirstudio.com)
+
 ## License
 
 This project is licensed under the AGPL-3.0 License.