You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Our project consists of three main packages, each designed to enhance your database experience:
22
+
23
+
| Package Name | Description | Link |
24
+
|--------------|-------------|------|
25
+
|**wasm**| The rust source for DB, contains its core logic, optimisations, algorithms and cryptography functionality. |[View on GitHub](https://github.com/trust0-project/ridb-wasm)|
26
+
|**ridb**| Main project with RIDB core functionality. |[View on GitHub](https://github.com/trust0-project/ridb)|
27
+
|**ridb-level**| An Storage for level-based storage (NODEJS). |[View on GitHub](https://github.com/trust0-project/ridb-level)|
28
+
19
29
### Security
20
30
We take security very seriously and have implemented robust measures to ensure data protection. Below are the specifications for our security features:
21
31
@@ -25,6 +35,7 @@ We take security very seriously and have implemented robust measures to ensure d
25
35
|**Encryption**| Data is encrypted using AES-256-GCM (Advanced Encryption Standard with Galois/Counter Mode), which provides both confidentiality and integrity. [Learn more about AES-GCM](https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf)|
26
36
|**Integrity**| We ensure data integrity by hashing data with SHA3-512 and comparing it with the stored hash to detect any tampering. [Learn more about SHA-3](https://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.202.pdf)|
27
37
38
+
28
39
### Supported features
29
40
By default RIDB is bundled with a default InMemory storage with support for write, create, update, fetch one, remove, find and count operations.
30
41
@@ -39,147 +50,3 @@ By default RIDB is bundled with a default InMemory storage with support for writ
39
50
|**Integrity Plugin**| Support for data has not been tampered with |
40
51
| **IndexDB Storage** | Robust type safe replacement for Dexie
41
52
42
-
## Documentation
43
-
For detailed API documentation, please visit the [RIDB Documentation](docs/README.md).
44
-
45
-
## Install
46
-
In order to install simply run the following command
47
-
npm:
48
-
```
49
-
npm i @trust0/ridb --save
50
-
```
51
-
52
-
yarn:
53
-
54
-
```
55
-
yarn add @trust0/ridb
56
-
```
57
-
58
-
## Usage
59
-
Creating your own database is pretty straight forward.
0 commit comments