Skip to content

Commit 057d137

Browse files
hyperpolymathclaude
andcommitted
docs(readme): convert README.adoc -> Markdown README.md
README must be real Markdown to render in GitHub community-health, the GitHub profile, and external MCP directories (Glama) — AsciiDoc shows as raw markup there. pandoc asciidoc->GFM, badges fixed to clickable, SPDX header kept as an HTML comment, duplicate README.adoc removed. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 56164ed commit 057d137

2 files changed

Lines changed: 31 additions & 86 deletions

File tree

README.adoc

Lines changed: 0 additions & 57 deletions
This file was deleted.

README.md

Lines changed: 31 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,61 @@
1-
[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
2-
3-
= a2ml-pre-commit
4-
:toc: preamble
5-
:icons: font
1+
<!--
2+
SPDX-License-Identifier: CC-BY-SA-4.0
3+
SPDX-FileCopyrightText: 2025-2026 Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
65

7-
== Overview
6+
# Overview
87

98
**Pre-commit hook for validating A2ML manifest files.**
109

11-
A2ML (Agnostic Agent Markup Language) is a manifest format for machine-readable
12-
metadata, AI agent instructions, and project state. This hook validates `.a2ml`
13-
files on commit for structural correctness and required fields.
10+
A2ML (Agnostic Agent Markup Language) is a manifest format for
11+
machine-readable metadata, AI agent instructions, and project state.
12+
This hook validates `.a2ml` files on commit for structural correctness
13+
and required fields.
14+
15+
# Checks Performed
16+
17+
1. **SPDX header**`SPDX-License-Identifier` in the first 10 lines
18+
19+
2. **Identity fields** — Requires `agent-id`, `name`, or `project`
20+
(relaxed for AI-MANIFEST files)
1421

15-
== Checks Performed
22+
3. **Version field**`version` or `schema_version` presence
1623

17-
1. **SPDX header**`SPDX-License-Identifier` in the first 10 lines
18-
2. **Identity fields** — Requires `agent-id`, `name`, or `project` (relaxed for AI-MANIFEST files)
19-
3. **Version field**`version` or `schema_version` presence
20-
4. **Attestation blocks** — Validates `proof`/`signature`/`hash` fields if `[attestation]` section exists
24+
4. **Attestation blocks** — Validates `proof`/`signature`/`hash` fields
25+
if `[attestation]` section exists
2126

22-
== Installation
27+
# Installation
2328

2429
Add to your `.pre-commit-config.yaml`:
2530

26-
[source,yaml]
27-
----
31+
```yaml
2832
repos:
2933
- repo: https://github.com/hyperpolymath/a2ml-pre-commit
3034
rev: v1.0.0
3135
hooks:
3236
- id: validate-a2ml
33-
----
37+
```
3438
3539
Then install:
3640
37-
[source,bash]
38-
----
41+
```bash
3942
pre-commit install
40-
----
43+
```
4144

42-
== Manual Usage
45+
# Manual Usage
4346

4447
You can also run the hook script directly:
4548

46-
[source,bash]
47-
----
49+
```bash
4850
./hooks/validate-a2ml.sh path/to/file.a2ml [more-files.a2ml ...]
49-
----
51+
```
5052

51-
== Author
53+
# Author
5254

53-
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
55+
Jonathan D.A. Jewell \<[j.d.a.jewell@open.ac](j.d.a.jewell@open.ac).uk\>
5456

55-
== License
57+
# License
5658

5759
SPDX-License-Identifier: CC-BY-SA-4.0
5860

59-
See link:LICENSE[LICENSE] for details.
61+
See [LICENSE](LICENSE) for details.

0 commit comments

Comments
 (0)