Refresh documentation and policies and simplify releases

README.md

@@ -1,46 +1,44 @@
 # Audita
 
-Audita is a CLI that polishes transcript JSON using glossary-aware and LLM-backed correction modules.
+Audita polishes transcript JSON using glossary-aware and LLM-backed correction
+modules. It validates proposed corrections and produces corrected text plus
+reports for review and subprocess integration.
 
 ## Quickstart
 
-Build:
+From a checkout, build with Go 1.24 or newer:
 
 ```sh
 go build -o ./bin/audita ./cmd/audita
 ```
 
-Run the shortest useful command:
+Processing requires a reachable [compatible LLM endpoint](docs/integrations/openai-compatible-llm.md)
+and access to its configured model. Supply its credentials through the
+[configuration mechanisms](docs/config.md#secrets); the
+[minimal config](examples/minimal-config.yml) reads `AUDITA_LLM_API_KEY` and uses
+the [default model and endpoint](docs/config.md#llm-settings). Set that variable
+in your environment before using an endpoint that requires authentication.
+For another endpoint or model, edit a copy of the config.
+
+Run the included small input with the minimal config:
 
 ```sh
-audita process ./transcript.json --glossary ./glossary.yaml --output ./corrected.json
+./bin/audita process examples/tiny-transcript.json \
+  --config examples/minimal-config.yml \
+  --glossary examples/tiny-glossary.yaml \
+  --output corrected.json
 ```
 
-Notes:
-- the transcript JSON path is required as a positional argument;
-- `--glossary` is required;
-- without `--output`, corrected transcript JSON is written to stdout.
-
-## Configuration
-
-Audita loads defaults, optional file config, environment overrides, then CLI overrides.
-
-Use these commands to validate and inspect config:
-
-```sh
-audita config validate --config ./audita.yml
-audita config print-effective --config ./audita.yml
-```
+This makes LLM requests. Inherited configuration environment overrides still
+apply; see [precedence](docs/config.md#effective-precedence).
 
 ## Documentation
 
-- CLI reference: [`docs/cli.md`](docs/cli.md)
-- Configuration reference: [`docs/config.md`](docs/config.md)
-- Operations guide: [`docs/operations.md`](docs/operations.md)
-- Troubleshooting: [`docs/troubleshooting.md`](docs/troubleshooting.md)
-- Subprocess integration: [`docs/integrations/subprocess.md`](docs/integrations/subprocess.md)
-- OpenAI-compatible LLM integration: [`docs/integrations/openai-compatible-llm.md`](docs/integrations/openai-compatible-llm.md)
-- Transcript and glossary file integration: [`docs/integrations/transcript-glossary-files.md`](docs/integrations/transcript-glossary-files.md)
-- Development workflow: [`docs/policy/development.md`](docs/policy/development.md)
-- Architecture policy: [`docs/policy/architecture.md`](docs/policy/architecture.md)
-- Documentation policy: [`docs/policy/documentation.md`](docs/policy/documentation.md)
+- [CLI reference](docs/cli.md)
+- [Configuration and maintained examples](docs/config.md)
+- [Operations and artifact lifecycle](docs/operations.md)
+- [Transcript and glossary inputs](docs/integrations/transcript-glossary-files.md)
+- [Output files and report formats](docs/integrations/output-files.md)
+- [Subprocess integration](docs/integrations/subprocess.md)
+- [LLM endpoint contract](docs/integrations/openai-compatible-llm.md)
+- [Contributor guide](docs/development.md)