From f16d8bca5eae378f2e8292583cb10ac5732c3c12 Mon Sep 17 00:00:00 2001 From: Midia Kiasat Date: Mon, 2 Mar 2026 20:21:30 +0100 Subject: [PATCH] docs: standardize readme baseline --- README.md | 138 +++++++++++------------------------------------------- 1 file changed, 28 insertions(+), 110 deletions(-) diff --git a/README.md b/README.md index d56a319..9e6bfcf 100644 --- a/README.md +++ b/README.md @@ -1,128 +1,46 @@ -``` -PRIM-002 -IRREVOCULL -Irreversible judgment - -STATUS: REGISTERED -REGISTRY: https://speedkit.eu -SNAPSHOT: https://speedkit.eu/REGISTRY_SNAPSHOT.json -``` - -Registered artifact. Identity governed by SPEEDKIT registry. - -STATUS: FINAL - ---- - -IRREVOCULL renders irreversible judgments. - -It does not execute. -It does not repair. -It does not explain. - -It observes output and terminates evaluation. - ---- - -## Philosophy - -IRREVOCULL exists to **end deliberation**. - -It is designed for moments where: - -* Evaluation must conclude -* Ambiguity is unacceptable -* Responsibility cannot be deferred - -Once invoked, the result is binding. - ---- - -## Behavior - -* Consumes input **exclusively** via `stdin` -* Emits **exactly one** verdict: - - * `PASS` — complete, decisive output - * `FAIL` — detected incompleteness or contradiction - * `INVALID` — uncertainty, speculation, or misuse -* Exits immediately after judgment +# irrevocull -The verdict is final. +## Purpose -No retries. -No flags. -No configuration. -No mitigation. +Atomic primitive: irreversible cull / no-appeal enforcement. ---- +## Status -## Usage +- **Stability**: Experimental +- **SemVer**: Not guaranteed until v1.0.0 +- **Security**: See **Security** section below -IRREVOCULL is never run alone. -It must receive output. +## Scope -```sh - | ./irrevocull.sh -``` - -### Example - -```sh -echo "final answer" | ./irrevocull.sh -``` - -Output: +- What this repo is responsible for +- What it explicitly does **not** do -```text -PASS -``` - -```sh -echo "maybe later" | ./irrevocull.sh -``` +## Quickstart -Output: +```bash +# clone +git clone https://github.com/Verifrax/irrevocull.git +cd irrevocull -```text -FAIL +# install (adjust if needed) +# (placeholder) npm install / pnpm install / go test ./... / etc. ``` -Running without input: - -```sh -./irrevocull.sh -``` - -Output: - -```text -INVALID -``` - ---- - -## Contract - -Once observed, the verdict stands. - -Responsibility is absolute. -Blame is void. - -If you want nuance, do not run it. - ---- +## Repository layout -## Responsibility Boundary +- `/` Root sources +- `/.github/` Issue + PR templates +- `/docs/` Documentation (if present) -This software is provided under the MIT License. +## Security -The MIT License permits use, copying, modification, and redistribution of the code, but it does not provide assurance, certification, audit defense, operational guarantees, or liability coverage. +- Report vulnerabilities privately: **security@verifrax.org** +- Do **not** open public issues for sensitive findings -Use of this software in environments where failure, compliance, legal exposure, or irreversible decisions matter requires an accountable party. +## Contributing -The original maintainer is available for assurance, adaptation, and responsibility when such accountability is required. +See `CONTRIBUTING.md`. -Contact: contact@speedkit.eu +## License -Authoritative signed records are issued separately and are not produced by the software. +MIT. See `LICENSE`.