Skip to content

docs: update README.md with refined project description and features #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
allisson merged 1 commit into from
Jan 4, 2026
Merged

docs: update README.md with refined project description and features #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,11 @@

### 🎯 What is fastpubsub?

fastpubsub is **not** intended to replace production-grade messaging systems like Google Cloud Pub/Sub, NATS, or Apache Kafka. Instead, it brings key pub/sub features to **simple architectures** where you already have PostgreSQL available. If you're running a small to medium-sized application with PostgreSQL as your primary database, fastpubsub lets you add reliable messaging capabilities without introducing additional infrastructure complexity.
fastpubsub is **not** intended to replace dedicated high-throughput messaging systems like Google Cloud Pub/Sub, NATS, or Apache Kafka. Instead, it brings key pub/sub features to **simple architectures** where you already have PostgreSQL available. If you're running a small to medium-sized application with PostgreSQL as your primary database, fastpubsub lets you add reliable messaging capabilities without introducing additional infrastructure complexity.

**Use fastpubsub when you:**
- Already use PostgreSQL and want to avoid managing separate message brokers
- Want to keep your stack simple with fewer moving parts
- Need pub/sub functionality for small to medium workloads
- Prefer simplicity over maximum throughput
- Want a single database for both application data and messaging
Expand All @@ -28,12 +29,13 @@ fastpubsub is **not** intended to replace production-grade messaging systems lik
### ✨ Key Features

- 🎯 **Topic-based messaging** - Organize messages by topics
- 🔒 **Secure** - Built-in authentication with JWT and scope-based permissions
- 🔍 **Message filtering** - Subscribe to specific messages using JSON-based filters
- 🔄 **Automatic retries** - Configurable retry logic with exponential backoff
- 💀 **Dead Letter Queue (DLQ)** - Handle failed messages gracefully
- 📊 **Metrics & Monitoring** - Built-in subscription metrics and Prometheus support
- 🐳 **Docker-ready** - Easy deployment with Docker
- 🔒 **Reliable delivery** - Acknowledgment and negative-acknowledgment support
- 🛡️ **Reliable delivery** - Acknowledgment and negative-acknowledgment support
- 🧹 **Automatic cleanup** - Background jobs for message maintenance

## 🏗️ Architecture
Expand Down