Skip to content

Commit 1ac83c8

Browse files
committed
Add badges to readme
1 parent d543a8c commit 1ac83c8

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,10 @@
1-
# pgcachewatch
2-
pgcachewatch is a Python library crafted to empower applications with real-time PostgreSQL event notifications for efficient cache invalidation, directly leveraging existing PostgreSQL infrastructure. This approach eliminates the need for additional technologies for cache management, simplifying your stack while enhancing performance and real-time data consistency.
1+
# PGCacheWatch
2+
[![CI](https://github.com/janbjorge/PGCacheWatch/actions/workflows/ci.yml/badge.svg)](https://github.com/janbjorge/PGCacheWatch/actions/workflows/ci.yml?query=branch%3Amain)
3+
[![pypi](https://img.shields.io/pypi/v/PGCacheWatch.svg)](https://pypi.python.org/pypi/PGCacheWatch)
4+
[![downloads](https://static.pepy.tech/badge/PGCacheWatch/month)](https://pepy.tech/project/PGCacheWatch)
5+
[![versions](https://img.shields.io/pypi/pyversions/PGCacheWatch.svg)](https://github.com/janbjorge/PGCacheWatch)
6+
7+
PGCacheWatch is a Python library crafted to empower applications with real-time PostgreSQL event notifications for efficient cache invalidation, directly leveraging existing PostgreSQL infrastructure. This approach eliminates the need for additional technologies for cache management, simplifying your stack while enhancing performance and real-time data consistency.
38

49
## Key Advantages
510
- **Leverage Existing Infrastructure**: Utilizes PostgreSQL's native NOTIFY/LISTEN capabilities for event-driven cache invalidation, avoiding the overhead of integrating external caching systems.
@@ -8,20 +13,20 @@ pgcachewatch is a Python library crafted to empower applications with real-time
813
- **Simple Yet Powerful API**: Designed with simplicity in mind, offering a straightforward setup process and an intuitive API for managing cache invalidation logic.
914

1015
## Installation
11-
To install pgcachewatch, run the following command in your terminal:
16+
To install PGCacheWatch, run the following command in your terminal:
1217
```bash
1318
pip install pgcachewatch
1419
```
1520

16-
## Using pgcachewatch
21+
## Using PGCacheWatch
1722
### Setting Up
18-
Initialize PostgreSQL triggers to emit NOTIFY events on data changes. pgcachewatch provides utility scripts for easy trigger setup
23+
Initialize PostgreSQL triggers to emit NOTIFY events on data changes. PGCacheWatch provides utility scripts for easy trigger setup
1924
```bash
20-
pgcachewatch install --tables your_table_names
25+
pgcachewatch install <tables-to-cache>
2126
```
2227

2328
### FastAPI Example
24-
Example showing how to use pgcachewatch for cache invalidation in a FastAPI app
29+
Example showing how to use PGCacheWatch for cache invalidation in a FastAPI app
2530

2631
```python
2732
import asyncpg

0 commit comments

Comments
 (0)