patx/mongokv

add example and install block to readme for quick browsing

Commit d627905 · patx · 2025-12-16T20:40:44-05:00

Changeset: d627905ccf8dc061e3c26f6a3da871e972ef169b
Parents: d17d14032473a93458bb1afc9a730911d0afa845

Comments

No comments yet.

Diff

diff --git a/README.md b/README.md
index cf38b5e..9a9bfea 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,24 @@
 [![Logo](https://patx.github.io/mongokv/logo.png)](https://patx.github.io/mongokv) is a tiny sync/async key-value store 
 backed by PyMongo that provides a dead-simple Redis-like API (`set`, `get`, etc). Safe across threads, processes, and ASGI workers. 
 [Read the API docs and user guide to get started](https://patx.github.io/mongokv).
+
+
+### Usage
+
+```
+>>> from mongokv import Mkv
+
+>>> db = Mkv('mongodb://localhost:27071')
+>>> db.set('hello', {'name': 'world', 'status': 'green'})
+
+>>> db.get('hello')
+{'name': 'world', 'status': 'green'}
+```
+
+
+### Install
+
+```
+pip3 install mongokv
+```
+