From 57b6dff3b82bf71b92b5e912a700ecae5aea656c Mon Sep 17 00:00:00 2001
From: chereseeriepa <cherese.eriepa@outlook.com>
Date: Thu, 25 Jul 2024 12:00:14 +1200
Subject: [PATCH] fix: update leveldb readme

---
 packages/leveldb/README.md | 97 ++++++++++++++++++++++++++++++--------
 1 file changed, 78 insertions(+), 19 deletions(-)

diff --git a/packages/leveldb/README.md b/packages/leveldb/README.md
index 4dc6aca6..b8c1c93f 100644
--- a/packages/leveldb/README.md
+++ b/packages/leveldb/README.md
@@ -1,31 +1,90 @@
 # @pluto-encrypted/leveldb
-This package contains a RXDB compatible wrapper over leveldb and can be used as database engine inside @pluto-encrypted package with secure database encryption.
 
-### Documentation
-[@Pluto-encrypted REFERENCE](https://github.com/elribonazo/pluto-encrypted/blob/master/docs/README.md)
+## Overview
 
-### How to use
+`@pluto-encrypted/leveldb` provides a secure, encrypted storage solution for RxDB using LevelDB. By integrating encryption middleware, this package ensures data security and confidentiality while leveraging LevelDB's persistence features. It is ideal for applications that require robust and secure storage capabilities.
 
-Creating a levelDB compatible storage is very simple.
+This package uses `@pluto-encrypted/encryption` to wrap LevelDB with encryption, allowing for seamless integration with RxDB-based applications.
+
+## Installation
+
+To install the `@pluto-encrypted/leveldb` package, use npm or yarn:
+
+```bash
+npm install @pluto-encrypted/leveldb
+```
+
+or
+
+```bash
+yarn add @pluto-encrypted/leveldb
+```
+
+## Usage
+
+### Initialization
+
+To use `@pluto-encrypted/leveldb` with RxDB, you need to create an encrypted LevelDB storage instance. Below is an example of how to set it up:
 
 ```typescript
-import { createLevelDBStorage } from "@pluto-encrypted/leveldb";
-import { Database } from "@pluto-encrypted/database";
-//default password must be 32 bytes long
+import { createLevelDBStorage } from '@pluto-encrypted/leveldb';
+import { Database } from '@pluto-encrypted/database';
+
+// Ensure the default password is 32 bytes long
 const defaultPassword = new Uint8Array(32).fill(1);
-const database = db = await Database.createEncrypted(
-    {
-        name: `my-db`,
-        encryptionKey: defaultPassword,
-        storage: createLevelDBStorage({ 
-            dbName: "demo",
-            dbPath: "/tmp/demo" 
-        }),
-    }
-);
+
+const database = await Database.createEncrypted({
+  name: 'my-db',
+  encryptionKey: defaultPassword,
+  storage: createLevelDBStorage({
+    dbName: 'demo',
+    dbPath: '/tmp/demo' // Adjust the path as needed
+  })
+});
+```
+
+### Using with Atala Prism Wallet SDK
+
+Here’s how to integrate `@pluto-encrypted/leveldb` with the Atala Prism Wallet SDK:
+
+```typescript
+import { Agent, Domain, Store, Apollo, Pluto } from '@atala/prism-wallet-sdk';
+import { createLevelDBStorage } from '@pluto-encrypted/leveldb';
+
+const mediatorDIDString = 'your-mediator-did-string'; // Replace with your actual mediator DID string
+const mediatorDID = Domain.DID.fromString(mediatorDIDString);
+
+const store = new Store({
+  name: 'my-app-db',
+  storage: createLevelDBStorage({
+    dbName: 'my-app-db',
+    dbPath: '/path/to/db'
+  }),
+  password: 'something secure 1235!' // Use a secure password
+});
+const apollo = new Apollo();
+const pluto = new Pluto(store, apollo);
+
+const agent = Agent.initialize({ mediatorDID, pluto, apollo });
 ```
 
+## Contributing
+
+We welcome contributions! Please read our [Contributing Guide](https://github.com/atala-community-projects/pluto-encrypted/blob/master/CONTRIBUTING.md) for details on our code of conduct and the process for submitting pull requests.
+
+## License
+
+This project is licensed under the Apache License, Version 2.0. See [LICENSE](./LICENSE) for the full terms and conditions.
+
+## Support
+
+If you have any questions or need help, feel free to open an issue on our [GitHub repository](https://github.com/atala-community-projects/pluto-encrypted/issues).
+
+---
+
 ## QA & Documentation
 | Statements                  | Branches                | Functions                 | Lines             |
 | --------------------------- | ----------------------- | ------------------------- | ----------------- |
-| ![Statements](https://img.shields.io/badge/statements-92.85%25-brightgreen.svg?style=flat) | ![Branches](https://img.shields.io/badge/branches-75%25-red.svg?style=flat) | ![Functions](https://img.shields.io/badge/functions-94.11%25-brightgreen.svg?style=flat) | ![Lines](https://img.shields.io/badge/lines-94.5%25-brightgreen.svg?style=flat) |
+| ![Statements](https://img.shields.io/badge/statements-100%25-brightgreen.svg?style=flat) | ![Branches](https://img.shields.io/badge/branches-100%25-brightgreen.svg?style=flat) | ![Functions](https://img.shields.io/badge/functions-100%25-brightgreen.svg?style=flat) | ![Lines](https://img.shields.io/badge/lines-100%25-brightgreen.svg?style=flat) |
+
+---