tittle-xyz/toaster-ready

Score a repo's ramp-up readiness (for humans + AI agents) and gate CI below a threshold.

Trust Signals

name	description	required	default
target	Path or owner/repo to score.	no	.
min	Minimum score (0-100) to pass. Overrides the config gate threshold.	no	""
config	Path to a .toaster-ready.yml config file.	no	""
version	Version of toaster-ready to install (e.g. v0.1.1 or latest).	no	latest
badge	Write a readiness badge to this path (e.g. docs/badge.svg or badge.json); format is inferred from the extension (.svg \| .json). Empty = off. Pair with `commit: true`, or commit it yourself in a following step.	no	""
commit	Commit and push the badge to the current branch when it changes. Off by default. Needs `contents: write` and a branch the workflow token may push to — a protected default branch will reject it, so refresh the badge on a release PR branch rather than on main.	no	false
token	Token for the API-backed signals (latest CI run, branch protection). Defaults to the workflow token, which is sufficient for both on the repo being scored. Without one the score lands ~6 points low on a runner: Actions IPs share the unauthenticated API allowance and it is reliably spent, so the lookups 403 and report no-data. Pass an empty string to score without the API on purpose.	no	${{ github.token }}

no outputs