Skip to content

docs: standardize README to alltuner brand structure - #40

Merged
davidpoblador merged 4 commits into
mainfrom
standardize-readme
May 4, 2026
Merged

davidpoblador merged 4 commits into
mainfrom
standardize-readme

Conversation

@davidpoblador

Copy link
Copy Markdown
Member

Summary

  • Adds the centered hero (title, tagline, link row, Wine-coloured stars shield).
  • Reorders sections: "What is Nameplate?" leads (the concept-first ordering switchyard uses), then Get Started, then Configuration.
  • Adds the canonical "Support the project" block.
  • Adds the canonical centered Poblenou footer signature.
  • Substantive content (CoreDNS plugin table, env-var table, split-DNS walkthrough, CNAME aliases, upgrade notes) preserved verbatim.

Follows the canonical README template at alltuner/brand:readme-template.

Follow-up

This repo has no LICENSE file and no license declared on GitHub. The README intentionally omits the ## License section to avoid claiming terms that aren't actually set. Recommend a separate PR adding LICENSE (MIT, to match the rest of the org) and the ## License section.

Test plan

  • Render on github.com and verify the centered blocks and tables.
  • Confirm the docker-compose snippet still copy-pastes cleanly.

🤖 Generated with Claude Code

davidpoblador and others added 2 commits May 4, 2026 09:03
Adds the centered hero with brand-coloured shields, the canonical sponsor
block, and the Poblenou footer. Reorders sections so 'What is Nameplate?'
leads, then Get Started, then Configuration. Substantive content preserved.
Follows the canonical README template at alltuner/brand:readme-template.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Adds a LICENSE file (MIT, copyright 2026 David Poblador i Garcia / All
Tuner Labs, matching the rest of the org). Reorders so 'Get Started'
precedes 'What is Nameplate?' to match the canonical section order in
alltuner/brand:readme-template. Adds the previously-omitted '## License'
section now that LICENSE exists. Replaces the per-block GitHub Sponsors
/ Buy Me a Coffee URLs with a single link to alltuner.com/sponsor. Hero
Sponsor link updated to match.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@davidpoblador davidpoblador changed the title Standardize README to alltuner brand structure docs: standardize README to alltuner brand structure May 4, 2026
davidpoblador and others added 2 commits May 4, 2026 09:32
License now closes the technical content; Support sits right next to
the centered Built-by footer signature, where the personal call-to-
action belongs. Matches the updated section order in
alltuner/brand:readme-template.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Swaps the centered text H1 for the canonical horizontal lockup image
served from brand.alltuner.com. The lockup contains the wine-circle
mark, project name, and "BY ALL TUNER LABS" attribution as one
graphic — replaces the duplicate text H1 cleanly. Source assets in
alltuner/brand:public/logos/<slug>/.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@davidpoblador
davidpoblador merged commit 16816be into main May 4, 2026
3 checks passed
@davidpoblador
davidpoblador deleted the standardize-readme branch May 4, 2026 08:31
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