From 4255c82ba8249050c28dbfa4c3454f51f0bbf240 Mon Sep 17 00:00:00 2001 From: tegwick Date: Mon, 25 May 2026 00:13:07 +0200 Subject: [PATCH] Point README at citation-evidence umbrella during MVP phase Code lives upstream in citation-evidence/src/{shared,engine}/ during the MVP. This README documents that, links the shared-contracts doc as the authoritative source for type/state changes, and notes engine's leaf-node position in the dependency map. Co-Authored-By: Claude Opus 4.7 --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 800621f..2b251f7 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -Domain model and tooling for citations. +# citation-engine + +Domain model and tooling for citations — the shared vocabulary +(`Document`, `Selector`, `Annotation`, `EvidenceItem`, `EvidenceLink`, +`EvidenceSet`, state enums, branded IDs, canonical text normalization) +together with the services and repositories that act on it. + +## MVP status: INTENT only + +During the citation-evidence MVP, code lives upstream in +[`citation-evidence`](../citation-evidence/) under `src/shared/` and +`src/engine/`. This repo currently holds `INTENT.md` describing what will +move here once the engine API stabilises. Until extraction, contract +changes belong in +[`citation-evidence/wiki/SharedContracts.md`](../citation-evidence/wiki/SharedContracts.md), +not here. + +The dependency map (`citation-evidence/wiki/DependencyMap.md`) marks this +package as a **leaf node**: nothing internal depends on anything else.