Skip to content

docs(readme): adopt the AntelopeJS framework README style - #41

Merged
Upd4ting merged 1 commit into
mainfrom
docs/framework-readme
Nov 12, 2026
Merged

Upd4ting merged 1 commit into
mainfrom
docs/framework-readme

Conversation

@Upd4ting

@Upd4ting Upd4ting commented Nov 12, 2026 •

Copy link
Copy Markdown
Member

Why

The template-module-typescript README adopts the framework README shape approved in ANT-2094. A visitor sees on the first screen that the template is part of AntelopeJS, can star AntelopeJS, and finds the other contracts and providers.

What changes

  • @antelopejs/tooling-configs goes from ^0.5.4 to ^0.5.5, which ships the README strip command.
  • .github/readme/strip.svg is written by antelopejs-readme-strip --kind template --name module-typescript (label TEMPLATE · MODULE TYPESCRIPT) and opens the README, linking to AntelopeJS/antelopejs.
  • A centred header holds the title, the black badges plus Star AntelopeJS, the GitHub description in bold, and the links line.
  • A closing ## Part of AntelopeJS section with the one-sentence framework pitch sits between ## Contributing and ## License. Templates carry no framework modules table, so the README has no antelopejs-framework-modules markers and antelopejs-sync writes nothing into it.
  • Every other section keeps its text and its order.

Since this repository is the template ajs module init copies, a new module also starts with this README and strip. Renaming them is part of making the module yours, like the package name.

Proof

$ pnpm run sync
Guardrails are in sync.
$ pnpm run checks
Checks: 12 passed, 0 failed.

Before and after screenshots of the rendered README are in the task thread.

@Upd4ting
Upd4ting force-pushed the docs/framework-readme branch from faf8433 to d66cb10 Compare November 12, 2026 13:40
@Upd4ting
Upd4ting merged commit 4054735 into main Nov 12, 2026
8 checks passed
@Upd4ting
Upd4ting deleted the docs/framework-readme branch November 12, 2026 14:08
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