Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bbambozzi authored Feb 10, 2024
1 parent 04064c1 commit 91d2fb3
Showing 1 changed file with 20 additions and 4 deletions.
24 changes: 20 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ SariDB is a minimalist, file-reconstructible key-value database. It can be embed
- **Concurrency First:** SariDB provides built-in concurrency safety mechanisms, allowing multiple threads to operate on the database simultaneously without compromising data consistency.

## Usage Example
(Subject to change)

### Embedded Example

```java
SariDB sariDB = SariDB
Expand All @@ -28,12 +29,27 @@ SariDB sariDB = SariDB
.filePath("path/to/db.parquet") // Save your .parquet wherever!
.reconstruct(false) // Reconstruct or start anew?
.build(); // That's all folks.
sariDB.start(); // 🚀

sariDB.set("key", "someValue")
sariDB.get("key") // returns "someValue"
```

### Standalone Example
```java
SariDB sariDB = SariDB
.builder()
.isEmbedded(true) // Embedded or standalone?
.filePath("path/to/db.parquet") // Save your .parquet wherever!
.reconstruct(false) // Reconstruct or start anew?
.portNumber(1337) // Set the port number..
.build(); // ..And that's all folks!
sariDB.start(); // Listening on port 1337 🚀!

```


## Add to your project (NOT YET IMPLEMENTED -- SOON!)
## Downloads
## Add to your project (NOT YET IMPLEMENTED)
### Downloads

[Download latest version (Not yet implemented)](https://google.com) or add to `pom.xml`:

Expand Down

0 comments on commit 91d2fb3

Please sign in to comment.