Refresh README and operations guide

This commit is contained in:
2026-07-31 01:00:21 +00:00
parent ad3b788f8c
commit 0c27fab384
2 changed files with 108 additions and 234 deletions

View File

@@ -1,10 +1,10 @@
# weatherreporter
`weatherreporter` is a Go application for preparing human-facing weather
reports from normalized forecast data. It builds JSON module snapshots, passes
YAML prompt data packages to `scriptorium`, and keeps inspectable artifacts
under a local workspace. It can also upload successfully generated managed
Markdown reports to a configured `distributor` HTTP upload endpoint.
Weatherreporter is a Go CLI that turns normalized weather data into managed,
human-facing Markdown reports.
It provides repeatable reports with inspectable local artifacts, so operators
can review what was collected and generated for every run.
## Quickstart
@@ -12,11 +12,14 @@ Markdown reports to a configured `distributor` HTTP upload endpoint.
weatherreporter generate today --out ./today.md
```
Configure a Weather API endpoint first; see the
[configuration reference](docs/config.md).
## Documentation
- [CLI reference](docs/cli.md)
- [Configuration reference](docs/config.md)
- [Operations guide](docs/operations.md)
- [Troubleshooting](docs/troubleshooting.md)
- [Architecture policy](docs/policy/architecture.md)
- [Development guide](docs/development.md)
- [Architecture policy](docs/policy/architecture.md)