From 996c23bff33ec9b974e185c1e02413e85704aa43 Mon Sep 17 00:00:00 2001 From: Dinushi Dhananjani Date: Fri, 3 Jul 2026 18:09:09 +0530 Subject: [PATCH] docs: add screenshots and fix README for v0.3.0 --- README.md | 89 ++++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 62 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index b40034e..46609d8 100644 --- a/README.md +++ b/README.md @@ -35,6 +35,22 @@ None of it is versioned. None of it is reviewable. None of it executes itself at --- +## See it in action + +**`burnless init` — interactive wizard generates your sre.yaml in 60 seconds** + +burnless init interactive wizard + +**`burnless status` — see your full SLO config at a glance** + +burnless status output + +**`burnless toil report` — convert manual toil to dollar cost for your manager** + +burnless toil report output + +--- + ## Installation ### macOS — Homebrew (recommended) @@ -72,7 +88,7 @@ Download the latest binary for your platform from ```bash burnless version -# burnless 0.2.0 +# burnless v0.3.0 ``` --- @@ -80,23 +96,26 @@ burnless version ## Quick start ```bash -# Install -curl -fsSL https://burnless.dev/install.sh | sh - -# Scaffold a new sre.yaml +# Create your sre.yaml interactively burnless init -# Validate -burnless validate sre.yaml +# Validate your config +burnless validate -# Deploy to Prometheus + Grafana + PagerDuty -burnless apply sre.yaml +# Preview what apply will create +burnless diff -# Watch live burn rate -burnless status payments-api +# Check your SLO config summary +burnless status -# Start the auto-remediation agent -burnless agent start +# Log a toil event +burnless toil log --service payments-api --task manual-rollback --duration 45m --automatable + +# Generate a cost report +burnless toil report --month 2026-07 + +# Export for your manager +burnless toil export --output toil.csv ``` --- @@ -112,7 +131,7 @@ team: platform-engineering slos: - name: availability - target: 99.9% + target: 99.9 window: 30d indicator: metric: http_requests_total @@ -121,12 +140,11 @@ slos: error_budget: burn_rate_alerts: - severity: critical - rate: 14.4x + rate: 14.4 window: 1h remediate: scale-up - - severity: warning - rate: 6x + rate: 6 window: 6h remediate: restart-pods @@ -134,14 +152,11 @@ runbooks: scale-up: mode: auto steps: - - kubectl scale deploy/payments --replicas=+2 - - wait 60s - - assert slo.availability > 99.5% - + - kubectl scale deploy/payments-api --replicas=+2 restart-pods: mode: semi-auto steps: - - kubectl rollout restart deploy/payments + - kubectl rollout restart deploy/payments-api oncall: provider: pagerduty @@ -159,6 +174,27 @@ dashboards: --- +## What's built today + +| Command | What it does | +|---|---| +| `burnless init` | Interactive wizard — generates a complete `sre.yaml` | +| `burnless validate` | Validates `sre.yaml` — exits 1 on failure, CI/CD safe | +| `burnless diff` | Previews what `apply` would create | +| `burnless status` | Displays SLO config, alerts, runbooks, on-call summary | +| `burnless toil log` | Logs a manual toil event | +| `burnless toil report` | Generates monthly cost report with automation priority | +| `burnless toil export` | Exports toil data as CSV or JSON | + +## Coming soon (Phase 2) + +- `burnless apply` — deploy SLO config to Prometheus + Grafana +- Burn rate agent — watches Prometheus every 60s, triggers runbooks automatically +- PagerDuty + Slack integrations +- Kubernetes operator + Helm chart + +--- + ## Documentation - [Getting started](docs/getting-started.md) @@ -166,18 +202,17 @@ dashboards: - [CLI reference](docs/reference/cli.md) - [Integrations](docs/integrations.md) - [Security & Data Handling](docs/security.md) -- [Data Flow Diagram](docs/data-flow.html) - [Contributing](CONTRIBUTING.md) +--- + ## Community - [Discord](https://discord.gg/burnless) - [Twitter / X](https://twitter.com/burnlessdev) -- [Blog](https://burnless.dev/blog) +- [GitHub Discussions](https://github.com/Custos-com/Burnless/discussions) -## License - -Apache 2.0 — see [LICENSE](LICENSE). +--- ## License