Add sponsor badge

Author: hyperpolymath

README.md

@@ -0,0 +1,236 @@
+[![Sponsor](https://img.shields.io/badge/Sponsor-%E2%9D%A4-pink?logo=github)](https://github.com/sponsors/hyperpolymath)
+
+= a2ml_ex
+:toc: preamble
+:icons: font
+
+image:https://img.shields.io/badge/OpenSSF-Best_Practices-green?logo=opensourcesecurity[OpenSSF Best Practices, link="https://www.bestpractices.dev/en/projects/new?repo_url=https://github.com/hyperpolymath/a2ml_ex"]
+
+== Overview
+
+**Elixir implementation of A2ML (Attested Markup Language) parser and renderer.**
+
+A2ML is a structured markup language with built-in attestation provenance, directive metadata, and trust-level tracking. This library provides a complete parser and renderer for A2ML documents in pure Elixir.
+
+== Features
+
+* Parse A2ML documents from strings or files
+* Render AST back to A2ML surface syntax (round-trip support)
+* Typed AST with structs for blocks, inlines, directives, and attestations
+* Trust-level hierarchy: `:unverified`, `:automated`, `:reviewed`, `:verified`
+* Directive blocks with key-value attributes
+* Attestation provenance chain
+* Zero dependencies beyond Elixir standard library
+
+== Quick Start
+
+Add to your `mix.exs`:
+
+[source,elixir]
+----
+defp deps do
+  [{:a2ml_ex, git: "https://github.com/hyperpolymath/a2ml_ex.git"}]
+end
+----
+
+Then run:
+
+[source,bash]
+----
+mix deps.get
+mix compile
+----
+
+== Usage
+
+[source,elixir]
+----
+# Parse A2ML document
+{:ok, document} = A2ML.parse("# Hello World\n\nSome **bold** text.")
+
+# Render back to A2ML
+{:ok, rendered} = A2ML.render(document)
+
+# Handle parse errors
+{:error, %A2ML.ParseError{}} = A2ML.parse("invalid syntax")
+----
+
+== Module Structure
+
+[cols="1,3"]
+|=== 
+| Module | Purpose
+
+| `A2ML`
+| Main module - re-exports public API
+
+| `A2ML.Document`
+| Document struct and functions
+
+| `A2ML.Block`
+| Block-level elements (headings, paragraphs, lists, etc.)
+
+| `A2ML.Inline`
+| Inline elements (bold, italic, code, links, etc.)
+
+| `A2ML.Directive`
+| Directive blocks with attributes
+
+| `A2ML.Attestation`
+| Attestation provenance and trust levels
+
+| `A2ML.Parser`
+| Parser implementation (string to AST)
+
+| `A2ML.Renderer`
+| Renderer implementation (AST to string)
+
+| `A2ML.Error`
+| Error types and handling
+|=== 
+
+== A2ML Syntax Reference
+
+[source]
+----
+# Heading
+
+Paragraph with **bold**, *italic*, `code`, [link](url), and @ref(id).
+
+@directive-name(key=val): single line value
+
+@multi-line:
+Content spanning
+multiple lines
+@end
+
+!attest
+identity: Jonathan D.A. Jewell
+role: author
+trust-level: verified
+timestamp: 2026-03-16T00:00:00Z
+!end
+
+- Bullet list item
+- Another item
+
+> Block quote text
+
+```elixir
+defmodule Example do
+  def hello, do: "world"
+end
+```
+----
+
+== Development
+
+[source,bash]
+----
+mix deps.get       # Install dependencies
+mix compile         # Compile project
+mix test            # Run tests
+mix format          # Format code
+mix creds check     # Check credentials
+----
+
+== Configuration
+
+Add to `config/config.exs`:
+
+[source,elixir]
+----
+config :a2ml_ex,
+  default_trust_level: :reviewed,
+  strict_mode: true
+----
+
+== Related Libraries
+
+* link:https://github.com/hyperpolymath/a2ml-deno[a2ml-deno] — Deno/ReScript implementation
+* link:https://github.com/hyperpolymath/a2ml-rs[a2ml-rs] — Rust implementation  
+* link:https://github.com/hyperpolymath/a2ml-haskell[a2ml-haskell] — Haskell implementation
+* link:https://github.com/hyperpolymath/a2ml_gleam[a2ml_gleam] — Gleam implementation
+* link:https://github.com/hyperpolymath/tree-sitter-a2ml[tree-sitter-a2ml] — Tree-sitter grammar
+* link:https://github.com/hyperpolymath/vscode-a2ml[vscode-a2ml] — VS Code extension
+
+== Trust Levels
+
+A2ML supports four trust levels in a hierarchy:
+
+[cols="1,3"]
+|=== 
+| Level | Meaning
+
+| `:unverified`
+| Content has not been reviewed or attested
+
+| `:automated`
+| Content generated or verified by automated systems
+
+| `:reviewed`
+| Content reviewed by human but not formally verified
+
+| `:verified`
+| Content formally verified with cryptographic attestation
+|===
+
+== Directives
+
+Directives provide metadata and processing instructions:
+
+[source]
+----
+@page-break
+
+@toc(depth=3): Table of Contents
+
+@include(file="chapter1.a2ml"): 
+
+@template(name="article"):
+# {title}
+By {author}
+
+{content}
+@end
+----
+
+== Attestations
+
+Attestations provide cryptographic provenance:
+
+[source]
+----
+!attest
+identity: Alice Smith
+role: Editor
+trust-level: verified
+timestamp: 2026-03-16T12:00:00Z
+signature: 0xabc123...
+!end
+----
+
+== Performance
+
+The Elixir implementation is optimized for:
+
+* Fast parsing of large documents
+* Memory-efficient AST representation  
+* Concurrent rendering capabilities
+* Stream processing support
+
+== License
+
+SPDX-License-Identifier: MPL-2.0
+
+Copyright (c) 2026 Jonathan D.A. Jewell (hyperpolymath)
+
+See link:LICENSE[LICENSE] for full license text.
+
+== Contributing
+
+See link:CONTRIBUTING.adoc[CONTRIBUTING.adoc] for contribution guidelines.
+
+== Roadmap
+
+See link:ROADMAP.adoc[ROADMAP.adoc] for planned features and enhancements.