diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 740ad8d..0000000 --- a/README.adoc +++ /dev/null @@ -1,57 +0,0 @@ -= a2ml-pre-commit -:toc: preamble -:icons: font - -== Overview - -**Pre-commit hook for validating A2ML manifest files.** - -A2ML (Agnostic Agent Markup Language) is a manifest format for machine-readable -metadata, AI agent instructions, and project state. This hook validates `.a2ml` -files on commit for structural correctness and required fields. - -== Checks Performed - -1. **SPDX header** — `SPDX-License-Identifier` in the first 10 lines -2. **Identity fields** — Requires `agent-id`, `name`, or `project` (relaxed for AI-MANIFEST files) -3. **Version field** — `version` or `schema_version` presence -4. **Attestation blocks** — Validates `proof`/`signature`/`hash` fields if `[attestation]` section exists - -== Installation - -Add to your `.pre-commit-config.yaml`: - -[source,yaml] ----- -repos: - - repo: https://github.com/hyperpolymath/a2ml-pre-commit - rev: v1.0.0 - hooks: - - id: validate-a2ml ----- - -Then install: - -[source,bash] ----- -pre-commit install ----- - -== Manual Usage - -You can also run the hook script directly: - -[source,bash] ----- -./hooks/validate-a2ml.sh path/to/file.a2ml [more-files.a2ml ...] ----- - -== Author - -Jonathan D.A. Jewell - -== License - -SPDX-License-Identifier: CC-BY-SA-4.0 - -See link:LICENSE[LICENSE] for details. diff --git a/README.md b/README.md index bb1b075..83cbf9a 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,61 @@ -[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath) - -= a2ml-pre-commit -:toc: preamble -:icons: font + -== Overview +# Overview **Pre-commit hook for validating A2ML manifest files.** -A2ML (Agnostic Agent Markup Language) is a manifest format for machine-readable -metadata, AI agent instructions, and project state. This hook validates `.a2ml` -files on commit for structural correctness and required fields. +A2ML (Agnostic Agent Markup Language) is a manifest format for +machine-readable metadata, AI agent instructions, and project state. +This hook validates `.a2ml` files on commit for structural correctness +and required fields. + +# Checks Performed + +1. **SPDX header** — `SPDX-License-Identifier` in the first 10 lines + +2. **Identity fields** — Requires `agent-id`, `name`, or `project` + (relaxed for AI-MANIFEST files) -== Checks Performed +3. **Version field** — `version` or `schema_version` presence -1. **SPDX header** — `SPDX-License-Identifier` in the first 10 lines -2. **Identity fields** — Requires `agent-id`, `name`, or `project` (relaxed for AI-MANIFEST files) -3. **Version field** — `version` or `schema_version` presence -4. **Attestation blocks** — Validates `proof`/`signature`/`hash` fields if `[attestation]` section exists +4. **Attestation blocks** — Validates `proof`/`signature`/`hash` fields + if `[attestation]` section exists -== Installation +# Installation Add to your `.pre-commit-config.yaml`: -[source,yaml] ----- +```yaml repos: - repo: https://github.com/hyperpolymath/a2ml-pre-commit rev: v1.0.0 hooks: - id: validate-a2ml ----- +``` Then install: -[source,bash] ----- +```bash pre-commit install ----- +``` -== Manual Usage +# Manual Usage You can also run the hook script directly: -[source,bash] ----- +```bash ./hooks/validate-a2ml.sh path/to/file.a2ml [more-files.a2ml ...] ----- +``` -== Author +# Author -Jonathan D.A. Jewell +Jonathan D.A. Jewell \<[j.d.a.jewell@open.ac](j.d.a.jewell@open.ac).uk\> -== License +# License SPDX-License-Identifier: CC-BY-SA-4.0 -See link:LICENSE[LICENSE] for details. +See [LICENSE](LICENSE) for details.