Skip to content

Commit 9ceaef7

Browse files
committed
fix: add documentation
1 parent eb9289a commit 9ceaef7

File tree

6 files changed

+4004
-9
lines changed

6 files changed

+4004
-9
lines changed

README.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
- [🔧 Advanced Features](#-advanced-features)
2828
- [🎮 Examples](#-examples)
2929
- [🏗️ Architecture](#️-architecture)
30+
- [📚 Documentation](#-documentation)
3031
- [🤝 Contributing](#-contributing)
3132
- [📄 License](#-license)
3233

@@ -54,7 +55,8 @@ import (
5455
)
5556

5657
func main() {
57-
// Create queue service
58+
59+
// Create queue service
5860
queueSvc := goqueue.NewQueueService(
5961
options.WithConsumer(myConsumer),
6062
options.WithPublisher(myPublisher),
@@ -118,9 +120,6 @@ func handleMessage(ctx context.Context, m interfaces.InboundMessage) error {
118120
```bash
119121
# Install the core library
120122
go get -u github.com/bxcodec/goqueue
121-
122-
# For RabbitMQ support (included by default)
123-
go get -u github.com/rabbitmq/amqp091-go
124123
```
125124

126125
### Requirements
@@ -365,18 +364,37 @@ Run the test suite:
365364

366365
```bash
367366
# Unit tests
368-
go test ./...
367+
make test
369368

370369
# Integration tests with RabbitMQ
371-
docker-compose -f test.compose.yaml up -d
372-
go test -tags=integration ./...
370+
make integration-test
373371

374-
# Benchmark tests
375-
go test -bench=. -benchmem ./...
376372
```
377373

378374
---
379375

376+
## 📚 Documentation
377+
378+
### 📖 Component Documentation
379+
380+
Explore our comprehensive guides for each system component:
381+
382+
| Component | Description | Documentation |
383+
| --------------------- | ------------------------------------------- | ----------------------------------------------- |
384+
| 🔌 **Middleware** | Extend functionality with custom logic | [📖 Middleware Guide](docs/MIDDLEWARE.md) |
385+
| 📨 **Consumer** | Reliable message consumption and processing | [📖 Consumer Guide](docs/CONSUMER.md) |
386+
| 📤 **Publisher** | High-performance message publishing | [📖 Publisher Guide](docs/PUBLISHER.md) |
387+
| 🔄 **RabbitMQ Retry** | Advanced retry mechanisms for RabbitMQ | [📖 Retry Architecture](docs/RABBITMQ-RETRY.md) |
388+
389+
### 🎯 Quick Links
390+
391+
- **[📚 Full Documentation Index](docs/README.md)** - Complete documentation overview
392+
- **[🔧 API Reference](https://pkg.go.dev/github.com/bxcodec/goqueue)** - Go package documentation
393+
- **[🎮 Examples](examples/)** - Working code examples
394+
- **[🐛 Troubleshooting](docs/README.md#troubleshooting)** - Common issues and solutions
395+
396+
---
397+
380398
## 🤝 Contributing
381399

382400
We welcome contributions! Here's how to get started:

0 commit comments

Comments
 (0)