patx/mongokv

Refactor README.md for clarity and conciseness

Commit ac2a233 · patx · 2025-12-16T23:12:08-05:00

Changeset: ac2a233678510f6cddce4901bff55ed2792d7ae0
Parents: 72a35c044e1c5ef2d3e4dc0d80afd7b61d2f7967

Refactor README.md for clarity and conciseness

Removed redundant description and usage section from README.md.

Comments

No comments yet.

Diff

diff --git a/README.md b/README.md
index aa6454e..51b6e97 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,9 @@
 [![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). It is safe across threads, processes, 
+and ASGI workers. For help getting started, installation, advanced examples and more 
+read the [API Docs and User Guide here](https://patx.github.io/mongokv).
 
-**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
 
 ```python
 >>> from mongokv import Mkv
@@ -17,11 +14,3 @@ dead-simple Redis-like API (`set`, `get`, etc). Safe across threads, processes,
 >>> db.get('hello')
 {'name': 'world', 'status': 'green'}
 ```
-
-
-### Install
-
-```bash
-$ pip3 install mongokv
-```
-