@nebula-db/plugin-cache - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

README.md

+# @nebula-db/plugin-cache
+
+Query caching plugin for NebulaDB
+
+Part of the [NebulaDB](https://github.com/Nom-nom-hub/NebulaDB) project - a high-performance, reactive, TypeScript-first, schema-optional, embeddable NoSQL database.
+
+## Installation
+
+```bash
+npm install @nebula-db/plugin-cache
+```
+
+## Usage
+
+```typescript
+import { createDb } from '@nebula-db/core';
+import { MemoryAdapter } from '@nebula-db/adapter-memory';
+import { createCachePlugin } from '@nebula-db/plugin-cache';
+
+// Create the plugin
+const cachePlugin = createCachePlugin();
+
+// Create a database with the plugin
+const db = createDb({
+  adapter: new MemoryAdapter(),
+  plugins: [cachePlugin]
+});
+
+// Use the database with the plugin
+const users = db.collection('users');
+await users.insert({ name: 'Alice', age: 30 });
+```
+
+## Documentation
+
+For full documentation, visit the [NebulaDB GitHub repository](https://github.com/Nom-nom-hub/NebulaDB).
+
+## License
+
+MIT

package.json

 {
   "name": "@nebula-db/plugin-cache",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Query caching plugin for NebulaDB",
@@ -9,3 +9,4 @@ "main": "dist/index.js",
   "files": [
-    "dist"
+    "dist",
+    "README.md"
   ],
@@ -12,0 +13,0 @@ "scripts": {

Fixed alerts

No README

Quality

Package does not have a README. This may indicate a failed publish or a low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

1821

109.55%

Number of package files

2

100%

Number of medium quality alerts

1

-50%

Number of lines in readme file

41

Infinity%

No dependency changes