Initial commit

README.md

@@ -0,0 +1,47 @@
+# BIRD Exporter
+
+Prometheus exporter for BIRD routing daemon.
+
+## Quick Start
+
+```bash
+# Build
+make build
+
+# Test
+make test
+
+# Create Debian package
+make pkg-deb
+
+# Install package
+sudo dpkg -i ../bird-exporter_*.deb
+```
+
+## Configuration
+
+The Debian package installs a systemd service that reads configuration from `/etc/default/bird-exporter`:
+
+```bash
+# Edit service configuration
+sudo nano /etc/default/bird-exporter
+
+# Start service
+sudo systemctl start bird-exporter
+```
+
+Default configuration:
+```
+BIRD_RUN_USER=bird
+BIRD_RUN_GROUP=bird
+BIRD_EXPORTER_ARGS="-period=60s -bird.socket=/var/run/bird/bird.ctl"
+```
+
+## Documentation
+
+- **Manual page**: `man bird-exporter` (after package installation)
+- **Detailed documentation**: [doc/DETAILS.md](doc/DETAILS.md)
+
+## License
+
+See [LICENSE](LICENSE).