|
27 | 27 | - [🔧 Advanced Features](#-advanced-features)
|
28 | 28 | - [🎮 Examples](#-examples)
|
29 | 29 | - [🏗️ Architecture](#️-architecture)
|
| 30 | +- [📚 Documentation](#-documentation) |
30 | 31 | - [🤝 Contributing](#-contributing)
|
31 | 32 | - [📄 License](#-license)
|
32 | 33 |
|
@@ -54,7 +55,8 @@ import (
|
54 | 55 | )
|
55 | 56 |
|
56 | 57 | func main() {
|
57 |
| - // Create queue service |
| 58 | + |
| 59 | + // Create queue service |
58 | 60 | queueSvc := goqueue.NewQueueService(
|
59 | 61 | options.WithConsumer(myConsumer),
|
60 | 62 | options.WithPublisher(myPublisher),
|
@@ -118,9 +120,6 @@ func handleMessage(ctx context.Context, m interfaces.InboundMessage) error {
|
118 | 120 | ```bash
|
119 | 121 | # Install the core library
|
120 | 122 | go get -u github.com/bxcodec/goqueue
|
121 |
| - |
122 |
| -# For RabbitMQ support (included by default) |
123 |
| -go get -u github.com/rabbitmq/amqp091-go |
124 | 123 | ```
|
125 | 124 |
|
126 | 125 | ### Requirements
|
@@ -365,18 +364,37 @@ Run the test suite:
|
365 | 364 |
|
366 | 365 | ```bash
|
367 | 366 | # Unit tests
|
368 |
| -go test ./... |
| 367 | +make test |
369 | 368 |
|
370 | 369 | # Integration tests with RabbitMQ
|
371 |
| -docker-compose -f test.compose.yaml up -d |
372 |
| -go test -tags=integration ./... |
| 370 | +make integration-test |
373 | 371 |
|
374 |
| -# Benchmark tests |
375 |
| -go test -bench=. -benchmem ./... |
376 | 372 | ```
|
377 | 373 |
|
378 | 374 | ---
|
379 | 375 |
|
| 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 | + |
380 | 398 | ## 🤝 Contributing
|
381 | 399 |
|
382 | 400 | We welcome contributions! Here's how to get started:
|
|
0 commit comments