Skip to content

Commit 669e0ab

Browse files
docs: add comprehensive package documentation
- Installation and quickstart guide - Architecture and design documentation - API endpoints reference - Facade API documentation - Events and listeners reference - Prometheus metrics integration guide - Performance optimization guide - Configuration reference - Artisan commands documentation
1 parent af1a60e commit 669e0ab

File tree

11 files changed

+4840
-0
lines changed

11 files changed

+4840
-0
lines changed

docs/README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Laravel Queue Metrics Documentation
2+
3+
Welcome to the Laravel Queue Metrics documentation. This package provides comprehensive queue monitoring and metrics collection for Laravel applications.
4+
5+
## Getting Started
6+
7+
- [Installation](installation.md) - Complete installation guide
8+
- [Quick Start](quickstart.md) - Get up and running in 5 minutes
9+
- [Configuration Reference](configuration-reference.md) - All configuration options
10+
11+
## Core Features
12+
13+
- [Architecture Overview](architecture.md) - How the package works internally
14+
- [Facade API](facade-api.md) - Primary developer interface
15+
- [HTTP API](api-endpoints.md) - REST endpoints for metrics access
16+
- [Prometheus Export](prometheus.md) - Monitoring integration
17+
- [Artisan Commands](artisan-commands.md) - CLI tools and maintenance
18+
19+
## Extensibility
20+
21+
- [Hooks System](hooks.md) - Transform metrics data
22+
- [Events](events.md) - React to metrics changes
23+
24+
## Optimization
25+
26+
- [Performance Tuning](performance.md) - Optimize for your workload
27+
28+
---
29+
30+
**Need help?** See the [Quick Start Guide](quickstart.md).
31+
32+
**Found an issue?** Please report it on [GitHub](https://github.com/gophpeek/laravel-queue-metrics/issues).

0 commit comments

Comments
 (0)