Skip to content

docs(readme): header on the ecosystem standard (title, badges, QRAMM family line, links) - #46

Open
thebenignhacker wants to merge 1 commit into
mainfrom
docs/readme-header-2026-10-25-s2
Open

thebenignhacker wants to merge 1 commit into
mainfrom
docs/readme-header-2026-10-25-s2

Conversation

@thebenignhacker

Copy link
Copy Markdown
Member

This pull request lands 1 commit in README.md.

Included

  • docs(readme): header on the ecosystem standard (title, badges, QRAMM family line, links)

Verified on this exact tree

  • go build ./... exit 0, go vet ./... exit 0, go test -race -count=1 ./... exit 0 with 7 packages ok (go1.26.3).
  • Every link in the new header answers HTTP 200: https://qramm.org, https://qramm.org/learn/tls-analyzer-guide.html, the csnp/qramm, csnp/cryptoscan and csnp/cryptodeps repositories, and this repository's CI workflow page.
  • The CI badge renders CI - passing and the licence badge License: MIT, both HTTP 200.
  • marked 18.1.1 renders the header as title, badge row, family line, link row, then the description.
  • The text from ## Quick Start down is byte-identical to main (equal sha256 of the tail).

Not included

None

Closes

None

How to merge

Rebase and merge, so that each change stays its own commit on main.

…family line, links)

The README opens with the header block the other QRAMM repositories use:
a Markdown title, one badge row (CI, licence), the QRAMM family line, a
link row (Website, Docs), then the description.

- The title is a Markdown heading instead of a centred HTML block.
- The CI badge uses the repository's current name and workflow file
  (csnp/tls-analyzer, ci.yml); the old qramm-tls-analyzer name
  redirects to it.
- The Go Reference badge, the in-page navigation row and the horizontal
  rule leave the header; the contributing guide stays linked from the
  body.
- The family line takes the place of the sentence that named the QRAMM
  toolkit; csnp.org stays linked from the body.
- Everything from the first section heading down is unchanged.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant