readme library

Classes

ReadmeColumn
One table column: a solution name and the store refs its numbers are read under (e.g. hintful → android (+ any fallback), a rival → android-scv, never inheriting another solution's numbers).
ReadmeContent
The consumer-owned content of the section (manifest readme:). The package renders the table machinery; the consumer writes the marketing copy (intro, footnote, image, stamp).

Constants

kReadmeEnd → const String
kReadmeStart → const String
README markers delimiting the rendered block (HTML comments, so the section stays invisible in rendered markdown and existing sections migrate without touching the surrounding prose).

Functions

renderReadmeSection(ReadmeContent content, {GoldenStore? store, DateTime? now}) → String
Renders the whole README section for content: markers, heading, intro, the metric table (one row per publishable def, cells read from the store via store, default benchmarks.json in the cwd), footnote, image and stamp.
replaceReadmeSection(String text, String section) → String
Replaces the block between kReadmeStart and kReadmeEnd in text with section; appends the section when the markers are absent.