Skip to content

Commit e6a4a67

Browse files
docs(readme): convert README.adoc -> Markdown (renders on Glama/profile/community-health) (#40)
README was AsciiDoc → renders as raw markup in Markdown consumers (Glama MCP directory, GitHub community-health, GitHub profile). pandoc asciidoc→GFM (badges → clickable), SPDX header kept, duplicate `.adoc` removed. Part of the estate README-format fix. Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
1 parent 531a6b0 commit e6a4a67

2 files changed

Lines changed: 34 additions & 94 deletions

File tree

README.adoc

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

README.md

Lines changed: 34 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,58 @@
1-
[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
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+
-->
25

3-
// SPDX-License-Identifier: CC-BY-SA-4.0
4-
// (MPL-2.0 preferred; MPL-2.0 required for Hex.pm ecosystem)
6+
[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/hyperpolymath/a2ml_gleam/badge)](https://securityscorecards.dev/viewer/?uri=github.com/hyperpolymath/a2ml_gleam)
57

6-
= a2ml_gleam
7-
:toc: preamble
8-
:icons: font
8+
A2ML (AI Attestation Markup Language) parser and renderer for Gleam.
99

10-
image:https://api.securityscorecards.dev/projects/github.com/hyperpolymath/a2ml_gleam/badge[OpenSSF Scorecard,link="https://securityscorecards.dev/viewer/?uri=github.com/hyperpolymath/a2ml_gleam"]
10+
# Overview
1111

12-
A2ML (AI Attestation Markup Language) parser and renderer for Gleam.
12+
A pure Gleam library for parsing, manipulating, and rendering A2ML
13+
documents. A2ML is a lightweight markup language for expressing AI
14+
attestations, trust levels, and verification metadata.
15+
16+
# Features
17+
18+
- Full A2ML parser with error reporting
19+
20+
- Renderer for A2ML document output
1321

14-
== Overview
22+
- Trust level handling (Unverified, Automated, Reviewed, Verified)
1523

16-
A pure Gleam library for parsing, manipulating, and rendering A2ML documents.
17-
A2ML is a lightweight markup language for expressing AI attestations, trust
18-
levels, and verification metadata.
24+
- Attestation and directive support
1925

20-
== Features
26+
- Manifest extraction
2127

22-
* Full A2ML parser with error reporting
23-
* Renderer for A2ML document output
24-
* Trust level handling (Unverified, Automated, Reviewed, Verified)
25-
* Attestation and directive support
26-
* Manifest extraction
27-
* Roundtrip fidelity (parse then render preserves structure)
28+
- Roundtrip fidelity (parse then render preserves structure)
2829

29-
== Installation
30+
# Installation
3031

31-
[source,sh]
32-
----
32+
```sh
3333
gleam add a2ml_gleam
34-
----
34+
```
3535

36-
== Usage
36+
# Usage
3737

38-
[source,gleam]
39-
----
38+
```gleam
4039
import a2ml_gleam/parser
4140
import a2ml_gleam/renderer
4241
4342
let assert Ok(doc) = parser.parse("# My Document\n\n@version 1.0")
4443
let output = renderer.render(doc)
45-
----
44+
```
4645

47-
== Testing
46+
# Testing
4847

49-
[source,sh]
50-
----
48+
```sh
5149
gleam test
52-
----
50+
```
5351

54-
Wondering how this works? See link:EXPLAINME.adoc[].
52+
Wondering how this works? See [EXPLAINME.adoc](EXPLAINME.adoc).
5553

56-
== License
54+
# License
5755

58-
SPDX-License-Identifier: CC-BY-SA-4.0 +
59-
(MPL-2.0 preferred; MPL-2.0 required for Hex.pm ecosystem) +
60-
See link:LICENSE[LICENSE].
56+
SPDX-License-Identifier: CC-BY-SA-4.0\
57+
(MPL-2.0 preferred; MPL-2.0 required for Hex.pm ecosystem)\
58+
See [LICENSE](LICENSE).

0 commit comments

Comments
 (0)