Skip to content

Commit 7cba4b8

Browse files
committed
readme updated
1 parent 8a41cf0 commit 7cba4b8

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@
44

55
#### Entity driven read-through cache decorator tailored and optimized for event-driven invalidations 🚀
66

7-
This ensures fresh records with real-time update & synchronization support.
7+
You can think of it as plain cache decorator but with steroids 💊 It ensures fresh records with real-time update & synchronization support by using same old decorator.
8+
9+
To understand its mechanics, see [How It Works](#how-it-works) and Check [Why this library?](#why-this-library)
810

911
> Note: This project is under active development. Use with caution.
1012
@@ -158,7 +160,7 @@ def get_customer_callable_id(customer_id):
158160

159161
### ORM Integration
160162

161-
Cacheref supports direct integration with SQLAlchemy and Django ORM models. You can pass model classes directly to the `entity` parameter, and cacheref will automatically extract table names and primary keys even composite ones.
163+
Cacheref doesn’t interact closely with ORM internals by still being able to cache almost any of your query results. Just send model classes as entity to SQLAlchemy or Django ORM and it will extract entity name and primary keys (or composite) without needing extensive integration. This approach helps it remain lightweight and independent of those libraries!
162164

163165
> Note:
164166
> * Pickle is used as default serializer/deserializer. It can be customized
@@ -237,7 +239,7 @@ When an entity changes:
237239
3. Only those **specific caches/function calls are invalidated**
238240

239241

240-
This means you don't need to remember all the different ways an entity might be cached - just invalidate by entity ID, and all relevant caches are automatically cleared.
242+
This means you don't need to remember all the different ways an entity might be cached and change your 'read' codebase - just invalidate by entity ID, and all relevant caches are automatically cleared.
241243

242244
>❗ To ensure cache consistency across the system, please bear in mind these rules:
243245
>* Maintain idempotency across all functions using the same cache key (cache key being - function or entity signature)

0 commit comments

Comments
 (0)