Skip to content

Commit bbb9ade

Browse files
committed
chore(docs): convert README.md to README.adoc — adoc is estate standard
1 parent 33385e5 commit bbb9ade

2 files changed

Lines changed: 58 additions & 50 deletions

File tree

README.adoc

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
// SPDX-License-Identifier: MPL-2.0
2+
// (PMPL-1.0-or-later preferred; MPL-2.0 required for Hex.pm ecosystem)
3+
4+
= a2ml_gleam
5+
:toc: preamble
6+
:icons: font
7+
8+
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"]
9+
10+
A2ML (AI Attestation Markup Language) parser and renderer for Gleam.
11+
12+
== Overview
13+
14+
A pure Gleam library for parsing, manipulating, and rendering A2ML documents.
15+
A2ML is a lightweight markup language for expressing AI attestations, trust
16+
levels, and verification metadata.
17+
18+
== Features
19+
20+
* Full A2ML parser with error reporting
21+
* Renderer for A2ML document output
22+
* Trust level handling (Unverified, Automated, Reviewed, Verified)
23+
* Attestation and directive support
24+
* Manifest extraction
25+
* Roundtrip fidelity (parse then render preserves structure)
26+
27+
== Installation
28+
29+
[source,sh]
30+
----
31+
gleam add a2ml_gleam
32+
----
33+
34+
== Usage
35+
36+
[source,gleam]
37+
----
38+
import a2ml_gleam/parser
39+
import a2ml_gleam/renderer
40+
41+
let assert Ok(doc) = parser.parse("# My Document\n\n@version 1.0")
42+
let output = renderer.render(doc)
43+
----
44+
45+
== Testing
46+
47+
[source,sh]
48+
----
49+
gleam test
50+
----
51+
52+
Wondering how this works? See link:EXPLAINME.adoc[].
53+
54+
== License
55+
56+
SPDX-License-Identifier: MPL-2.0 +
57+
(PMPL-1.0-or-later preferred; MPL-2.0 required for Hex.pm ecosystem) +
58+
See link:LICENSE[LICENSE].

README.md

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

0 commit comments

Comments
 (0)