@wxn0brp/db 0.40.3 → 0.41.0

package/README.md

@@ -1,68 +1,67 @@
 # <img src="https://raw.githubusercontent.com/wxn0brP/ValtheraDB/master/logo.svg" alt="ValtheraDB Logo" width="36" height="36"> ValtheraDB (@wxn0brp/db)
 
-A lightweight file-based database management system that supports CRUD operations, custom queries and relations.
-
 [![npm version](https://img.shields.io/npm/v/@wxn0brp/db)](https://www.npmjs.com/package/@wxn0brp/db)
 [![License](https://img.shields.io/npm/l/@wxn0brp/db)](./LICENSE)
 [![Downloads](https://img.shields.io/npm/dm/@wxn0brp/db)](https://www.npmjs.com/package/@wxn0brp/db)
 
+**Welcome to ValtheraDB – a modular, embedded database for developers who want to build their perfect data layer. With a familiar API and unparalleled flexibility, ValtheraDB empowers you to take control of your data storage.**
+
+---
+
 ## Installation
 
 To install the package, run:
 
 ```bash
+# Using npm
 npm install @wxn0brp/db
-```
-
-## Usage
 
-You can import the necessary classes/functions from the package as follows:
+# Or using yarn
+yarn add @wxn0brp/db
 
-```javascript
-import { Valthera, ValtheraRemote, Relation, genId, ValtheraMemory, ValtheraAutoCreate } from "@wxn0brp/db";
+# Or using bun
+bun add @wxn0brp/db
 ```
 
-### Examples
-```javascript
-import { Valthera } from "@wxn0brp/db";
+## Our Philosophy: Control and Flexibility
 
-// Create a new Valthera database instance
-const db = new Valthera("./database");
+In a world of one-size-fits-all solutions, ValtheraDB is different. We believe that you, the developer, should have the final say on how your data is managed. Our core philosophy is built on two pillars:
 
-// Add a new document to the database
-const addResult = await db.add("users", { name: "John Doe", age: 30 });
-console.log(addResult); // { _id: "abcdefghi-4-9", name: "John Doe", age: 30 }
+*   **Unmatched Modularity:** The storage engine is just a plugin. Don't like JSON files? Use a single binary file, YAML, `localStorage`, or invent your own format. ValtheraDB's architecture is designed to adapt to your needs, not the other way around.
+*   **Pragmatic Power:** We provide powerful features like cross-database relations and a rich query API, but we keep it simple. ValtheraDB is designed for small to medium-sized applications where a custom-fit and developer experience are more important than supporting massive datasets.
 
-// Find all documents in the collection
-const findResults = await db.find("users", {});
-console.log(findResults); // [{ _id: "abcdefghi-4-9", name: "John Doe", age: 30 }]
+## Who is ValtheraDB for?
 
-// Find a single document in the collection.
-const user = await db.findOne("users", { $gt: { age: 25 } });
-console.log(user); // { _id: "abcdefghi-4-9", name: "John Doe", age: 30 }
+ValtheraDB is a great fit if you are:
 
-// Update a document in the collection
-const updateResult = await db.updateOne("users", { name: "John Doe" }, { age: 31 });
-console.log(updateResult); // true
+*   A **Node.js or Bun developer** building a backend and wanting an easy-to-use, embedded database without the overhead of a separate database server.
+*   A **frontend developer** creating a Progressive Web App (PWA) that needs offline capabilities or complex client-side storage.
+*   An **Electron developer** who needs a straightforward way to store data locally in a desktop application.
+*   A **creative coder** who wants to experiment with unconventional storage methods for your projects.
 
-// Remove a document from the collection
-const removeResult = await db.removeOne("users", { name: "John Doe" });
-console.log(removeResult); // true
-```
+In short, if you value flexibility and control over rigid conventions, you'll feel right at home.
 
-## Documentation
+## Key Features at a Glance
 
-Website: [https://wxn0brp.github.io/ValtheraDB/](https://wxn0brp.github.io/ValtheraDB/)
+*   🧱 **Pluggable Storage Engine:** Bring your own storage adapter.
+*   🤝 **Powerful Cross-Database Relations:** Create relationships between data across entirely separate database instances.
+*   🧠 **Familiar MongoDB-like API:** Start working quickly with an intuitive and expressive query language.
+*   🌐 **Runs Everywhere:** Optimized for **Bun**, great with **Node.js**, and fully capable in the **browser**.
+*   🚀 **Client-Server Ready:** Scale from an embedded solution to a client-server architecture when you need to.
+*   🚫 **Zero Configuration:** Point it to a directory, and you're good to go.
 
-For detailed information, refer to the following resources:
+## Where to Go Next?
 
-- [Valthera Documentation](./docs/valthera.md)
-- [Remote Valthera and Graph Client Documentation](./docs/remote.md)
-- [Search Options Documentation](./docs/search_opts.md)
-- [Find Options Documentation](./docs/find_opts.md)
-- [Updater Options Documentation](./docs/updater.md)
-- [Relation Documentation](./docs/relation.md)
-- [Graph Documentation](./docs/graph.md)
+- **Documentation Website**: [https://wxn0brp.github.io/ValtheraDB/](https://wxn0brp.github.io/ValtheraDB/)
+- **[Getting Started](docs/getting_started.md):** Jump into our hands-on tutorial and build your first application with ValtheraDB.
+- **[Core Concepts](docs/core_concepts.md):** Learn about the fundamental ideas that make ValtheraDB unique.
+- **API Reference:**
+    - [Valthera Class](docs/valthera.md)
+    - [Relations](docs/relation.md)
+    - [Search Operators](docs/search_opts.md)
+    - [Update Operators](docs/updater.md)
+    - [Find Options](docs/find_opts.md)
+    - [Remote](docs/remote.md)
 
 ## License
 

package/dist/version.js

@@ -1 +1 @@
-export const version = "0.40.3";
+export const version = "0.41.0";

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "@wxn0brp/db",
-  "version": "0.40.3",
+  "version": "0.41.0",
+  "description": "A modular, embedded database for developers who want control over their data storage.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "author": "wxn0brP",
@@ -24,8 +25,8 @@
     "lightweight"
   ],
   "dependencies": {
-    "@wxn0brp/db-client": ">=0.2.1",
-    "@wxn0brp/db-core": ">=0.2.7",
+    "@wxn0brp/db-client": ">=0.2.3",
+    "@wxn0brp/db-core": ">=0.3.0",
     "@wxn0brp/db-storage-dir": ">=0.1.4"
   },
   "devDependencies": {