From e1e8e77e0baf339741a0bff80488d5289c7f0e14 Mon Sep 17 00:00:00 2001 From: Midia Kiasat Date: Mon, 2 Mar 2026 20:21:21 +0100 Subject: [PATCH] docs: standardize readme baseline --- README.md | 199 ++++++++---------------------------------------------- 1 file changed, 28 insertions(+), 171 deletions(-) diff --git a/README.md b/README.md index 2afc657..4b6906d 100644 --- a/README.md +++ b/README.md @@ -1,189 +1,46 @@ -``` -PRIM-004 -VALIDEXOR -Deterministic verification - -STATUS: REGISTERED -REGISTRY: https://speedkit.eu -SNAPSHOT: https://speedkit.eu/REGISTRY_SNAPSHOT.json -``` - -Registered artifact. Identity governed by SPEEDKIT registry. - -STATUS: FINAL - ---- - -VALIDEXOR is a deterministic verifier. - -It does not decide. -It does not execute. -It does not repair. - -It evaluates whether a claim is **verifiable against observable reality**. - ---- - -## Philosophy - -VALIDEXOR exists to end ambiguity without creating authority. - -It is designed for moments where: - -* Claims must be checked, not debated -* Language must be anchored to facts -* Truth depends on falsifiability, not intent - -VALIDEXOR does not assert truth. -It asserts whether truth *can be asserted*. - ---- +# validexor -## What It Is +## Purpose -VALIDEXOR is a **verification primitive**. +Atomic primitive: validity extraction / verdict normalization. -It inspects input and determines whether it satisfies the minimum conditions required for verification. +## Status -The result is a verdict about **verifiability**, not correctness. +- **Stability**: Experimental +- **SemVer**: Not guaranteed until v1.0.0 +- **Security**: See **Security** section below ---- +## Scope -## What It Is Not +- What this repo is responsible for +- What it explicitly does **not** do -* Not a judge -* Not a linter -* Not an executor -* Not an interpreter -* Not an oracle +## Quickstart -VALIDEXOR never mutates state. +```bash +# clone +git clone https://github.com/Verifrax/validexor.git +cd validexor ---- - -## Behavior - -* Consumes input **exclusively** via `stdin` -* Refuses silent invocation -* Rejects speculative or hedged language -* Requires at least one falsifiable anchor -* Validates referenced git objects against repository state -* Emits exactly one verdict -* Exits immediately after evaluation - -No retries. -No flags. -No configuration. - ---- - -## Verdicts - -VALIDEXOR emits exactly one of the following: - -* `VERIFIED` — the claim is concrete and falsifiable -* `UNVERIFIABLE` — the claim lacks sufficient anchors -* `INVALID` — the claim contains speculation or invalid references - -The verdict concerns **structure**, not **truth**. - ---- - -## Usage - -VALIDEXOR is never run alone. -It must receive a claim. - -```sh - | ./validexor.sh +# install (adjust if needed) +# (placeholder) npm install / pnpm install / go test ./... / etc. ``` -### Example - -```sh -echo "build output hash is a3f9c21" | ./validexor.sh -``` - -Output: - -``` -VERIFIED -``` - -```sh -echo "this might be correct" | ./validexor.sh -``` - -Output: - -``` -INVALID -``` - ---- - -## Contract - -Once emitted: - -* The verdict stands -* Interpretation is external -* Responsibility remains with the claimant - -VALIDEXOR guarantees **verifiability**, not **accuracy**. - ---- - -## Design Constraints - -These constraints are intentional: - -* No configuration → no framing bias -* No execution → no side effects -* No judgment → no authority - -Verification precedes meaning. - ---- - -## Relationship to Other Artifacts - -* **GUILLOTINE** — executes -* **IRREVOCULL** — judges -* **ATTESTORIUM** — witnesses -* **VALIDEXOR** — verifies - -Each artifact performs exactly one irreversible role. - ---- - -## Warning - -Verification can invalidate narratives. - -That is the point. - ---- - -## About - -VALIDEXOR is a minimal, deterministic verifier for claims that must survive contact with reality. - -If you want persuasion, do not use it. -If you want verification, nothing else will do. - ---- +## 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`.