eric/weatherreporter
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

Document stateless output operations

Browse Source
This commit is contained in:
Eric Rakestraw
2026-08-01 20:11:57 +00:00
parent 97215ddb9b
commit bd34ec57f8
8 changed files with 183 additions and 322 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -1,19 +1,22 @@
# weatherreporter
Weatherreporter is a Go CLI that turns normalized weather data into managed,
Weatherreporter is a Go CLI that turns normalized weather data into
human-facing Markdown reports.
It provides repeatable reports with inspectable local artifacts, so operators
can review what was collected and generated for every run.
It produces a Markdown report at an operator-owned destination and can upload
the completed output through Distributor.
## Quickstart
```sh
weatherreporter generate today --out ./today.md
weatherreporter generate today
```
Configure a Weather API endpoint first; see the
[configuration reference](docs/config.md).
[configuration reference](docs/config.md). The report is written to
`today.md` in the current directory; use `--out` to choose another destination.
See the [CLI reference](docs/cli.md) and [operations guide](docs/operations.md)
for command and operating details.
## Documentation