Skip to content

Commit f66ecaa

Browse files
committed
info about JavaScript Client SDK added
Signed-off-by: P SIDHARTH <philkhanasidharth14@gmail.com>
1 parent 25a72a9 commit f66ecaa

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ We benchmarked Prithvi against Redis (v7.2) on the same machine using a custom l
3535

3636
- [Prithvi: A Key-Value Database](#prithvi-a-key-value-database)
3737
- [🧪 Benchmarking vs Redis](#-benchmarking-vs-redis)
38+
- [Tech Stack](#tech-stack)
3839
- [Contents](#contents)
3940
- [Features](#features)
4041
- [Getting Started](#getting-started)
@@ -43,6 +44,7 @@ We benchmarked Prithvi against Redis (v7.2) on the same machine using a custom l
4344
- [Commands](#commands)
4445
- [Persistence](#persistence)
4546
- [Architecture \& Design Notes](#architecture--design-notes)
47+
- [JavaScript Client SDK](#javascript-client-sdk)
4648
- [Metrics and Monitoring](#metrics-and-monitoring)
4749
- [Write-Ahead Logging (WAL)](#write-ahead-logging-wal)
4850
- [Security Warning](#security-warning)
@@ -143,6 +145,17 @@ Prithvi's persistence mechanism saves the in-memory state to `data/store.json`.
143145
- **`Map`**: Used as the primary data store to ensure thread-safe operations across multiple client connections.
144146
- **Background Tasks**: Two dedicated threads manage key expiry and auto-saving, keeping the main server loop responsive.
145147

148+
<br />
149+
150+
---
151+
152+
## JavaScript Client SDK
153+
154+
A lightweight JavaScript Client SDK is available to interact with Prithvi from browsers or Node.js.
155+
156+
It wraps the custom TCP protocol and exposes async `set`, `get`, `del`, `auth`, and other command helpers.
157+
🔗 [Prithvi JS SDK](https://github.com/psidh/prithvi-js-sdk) (Coming Soon)
158+
146159
---
147160

148161
### Metrics and Monitoring

0 commit comments

Comments
 (0)