|
1 | | -[](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 | +--> |
2 | 5 |
|
3 | | -// SPDX-License-Identifier: CC-BY-SA-4.0 |
4 | | -// (MPL-2.0 preferred; MPL-2.0 required for Hex.pm ecosystem) |
| 6 | +[](https://securityscorecards.dev/viewer/?uri=github.com/hyperpolymath/a2ml_gleam) |
5 | 7 |
|
6 | | -= a2ml_gleam |
7 | | -:toc: preamble |
8 | | -:icons: font |
| 8 | +A2ML (AI Attestation Markup Language) parser and renderer for Gleam. |
9 | 9 |
|
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 |
11 | 11 |
|
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 |
13 | 21 |
|
14 | | -== Overview |
| 22 | +- Trust level handling (Unverified, Automated, Reviewed, Verified) |
15 | 23 |
|
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 |
19 | 25 |
|
20 | | -== Features |
| 26 | +- Manifest extraction |
21 | 27 |
|
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) |
28 | 29 |
|
29 | | -== Installation |
| 30 | +# Installation |
30 | 31 |
|
31 | | -[source,sh] |
32 | | ----- |
| 32 | +```sh |
33 | 33 | gleam add a2ml_gleam |
34 | | ----- |
| 34 | +``` |
35 | 35 |
|
36 | | -== Usage |
| 36 | +# Usage |
37 | 37 |
|
38 | | -[source,gleam] |
39 | | ----- |
| 38 | +```gleam |
40 | 39 | import a2ml_gleam/parser |
41 | 40 | import a2ml_gleam/renderer |
42 | 41 |
|
43 | 42 | let assert Ok(doc) = parser.parse("# My Document\n\n@version 1.0") |
44 | 43 | let output = renderer.render(doc) |
45 | | ----- |
| 44 | +``` |
46 | 45 |
|
47 | | -== Testing |
| 46 | +# Testing |
48 | 47 |
|
49 | | -[source,sh] |
50 | | ----- |
| 48 | +```sh |
51 | 49 | gleam test |
52 | | ----- |
| 50 | +``` |
53 | 51 |
|
54 | | -Wondering how this works? See link:EXPLAINME.adoc[]. |
| 52 | +Wondering how this works? See [EXPLAINME.adoc](EXPLAINME.adoc). |
55 | 53 |
|
56 | | -== License |
| 54 | +# License |
57 | 55 |
|
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