Add output schema registry and public contract docs
This commit is contained in:
12
README.md
12
README.md
@@ -66,6 +66,16 @@ audita process transcript.json \
|
||||
--report-json report.json
|
||||
```
|
||||
|
||||
Select an explicit output schema (default is `bare-segments`):
|
||||
|
||||
```sh
|
||||
audita process transcript.json \
|
||||
--glossary glossary.yaml \
|
||||
--output-schema audita-v1 \
|
||||
--output corrected.json \
|
||||
--report-json report.json
|
||||
```
|
||||
|
||||
Recommended config-based run:
|
||||
|
||||
```sh
|
||||
@@ -139,6 +149,8 @@ audita config print-effective --config audita.yml
|
||||
```
|
||||
|
||||
For full config-file schema and examples, see [`docs/configuration.md`](docs/configuration.md).
|
||||
For output-schema details, see [`docs/output-schemas.md`](docs/output-schemas.md).
|
||||
For CLI/process compatibility guarantees, see [`docs/public-contract.md`](docs/public-contract.md).
|
||||
|
||||
### Modules
|
||||
|
||||
|
||||
Reference in New Issue
Block a user