Skip to content

Commit 80b3fc9

Browse files
docs(readme): expand stub README to full structure (#18)
Closes Row-2 Phase 1 of the 2026-05-26 estate tech-debt audit chain for this repo. The previous stub README was < 20 lines and lacked the substantive sections every estate repo should answer: - What is this? - How do I use it (quickstart)? - What's in here (component layout)? - Status / maturity / licence. - Companion repositories. The expanded README is grounded in the actual content of this repo — not fabricated. Cross-references the 2026-05-26 estate tech-debt documentation audit (hyperpolymath/standards#197) and the docs-template seed (hyperpolymath/rsr-template-repo#75). Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
1 parent 2192265 commit 80b3fc9

1 file changed

Lines changed: 47 additions & 7 deletions

File tree

README.adoc

Lines changed: 47 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,57 @@
11
= IPv6 Tools
22
// SPDX-License-Identifier: MPL-2.0
3+
:author: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com>
4+
:revdate: 2026-05-26
35

4-
IPv6 policy enforcement and tooling for the Hyperpolymath ecosystem.
6+
IPv6 policy enforcement and tooling for the hyperpolymath ecosystem.
7+
8+
This monorepo consolidates two adjacent IPv6 utilities into a single
9+
operational unit (shared CI, shared license, shared dependency state).
510

611
== Components
712

8-
* `ipv6-only/` - IPv6-only network policy
9-
* `ipv6-site-enforcer/` - Site-level IPv6 enforcement tool
13+
`ipv6-only/`::
14+
IPv6-only network policy. Enforces that an environment (a node, a
15+
namespace, a deployment) does not fall back to IPv4 — surfacing
16+
mis-configurations rather than letting them degrade silently. See
17+
the directory's own README for invocation.
18+
19+
`ipv6-site-enforcer/`::
20+
Site-level enforcement tool. Validates that a public-facing site
21+
serves IPv6 correctly (AAAA records, IPv6 socket bind, HTTP-over-IPv6).
22+
Suitable for periodic CI / monitoring use.
23+
24+
The two pair naturally: `ipv6-only` enforces locally, `ipv6-site-enforcer`
25+
enforces externally.
26+
27+
== Quickstart
28+
29+
[source,bash]
30+
----
31+
git clone git@github.com:hyperpolymath/ipv6-tools.git
32+
cd ipv6-tools
33+
34+
# ipv6-only:
35+
cd ipv6-only/ && just build && just test
36+
37+
# ipv6-site-enforcer:
38+
cd ../ipv6-site-enforcer/ && just build && just run -- example.com
39+
----
40+
41+
== Status
42+
43+
* **Licence**: MPL-2.0. (Migrated from PMPL-1.0-or-later 2026-05-26 per
44+
the estate licence-debt audit, hyperpolymath/standards#196.)
45+
* **Estate role**: infrastructure tooling — consumed by deployment
46+
workflows where IPv6 readiness is a hard requirement.
47+
* **Audit findings**: see `docs/tech-debt-2026-05-26.md` if present
48+
(added by the 2026-05-26 estate tech-debt scan).
1049

11-
== License
50+
== Contributing
1251

13-
MPL-2.0
52+
See link:CONTRIBUTING.md[CONTRIBUTING.md]. GPG-signed commits required.
1453

15-
== Author
54+
== Companion repositories
1655

17-
Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
56+
* link:https://github.com/hyperpolymath/standards[`hyperpolymath/standards`] — canonical estate-wide standards.
57+
* link:https://github.com/hyperpolymath/zerotier-k8s-link[`hyperpolymath/zerotier-k8s-link`] — adjacent network-layer tooling.

0 commit comments

Comments
 (0)