The Action collects context
On a push to main, the thin client reads the git diff and current README. No full repository upload and no AI provider key.
git diff + README.mdA small Action. A hosted engine.
A chat can rewrite a README when you remember to ask. ReadmeForge runs in the push workflow and keeps the expensive, copy-resistant work on its API.
The API does the work
The hosted service verifies the license tier, enforces the monthly quota, runs the AI docs-sync server-side, and returns the complete README.
POST /v1/syncReview or commit
PR mode opens a focused pull request by default. Pro can use commit mode to write the returned README directly to main.
mode: pr | commitSmall code changes. Expensive doc drift.
The prompt is tuned to update only affected README sections and to avoid inventing behavior the diff does not prove.
New or missing environment variables
Flags variables introduced in config, deployment files, and runtime access.
Changed CLI flags and commands
Keeps usage examples aligned with renamed, added, or removed options.
New API endpoints
Surfaces routes, methods, request shapes, and response changes visible in the patch.
Dependency and install changes
Updates package-manager commands, prerequisites, and version requirements.
A PR your reviewer can understand.
No mystery dashboard and no silent rewrite. The result lands where documentation changes already belong: a normal GitHub pull request.
README.md · docs: sync configuration and CLI usage+7 −3
@@ Configuration
42### Environment variables
43- `API_URL` — URL for the database
43+ `DATABASE_URL` — PostgreSQL connection string
44+ `LOG_LEVEL` — Optional logging verbosity
@@ Usage
61- forge serve --listen 3000
61+ forge serve --port 3000
.github/workflows/readmeforge.yml
.github/actions/readmeforge/action.yml
Start with review. Upgrade for scale.
The hosted API enforces the tier and monthly quota before each sync. Free is for public repositories; Pro adds private code and direct commits.
Free
$0 / month
- 20 syncs per month
- Public repositories only
- Pull-request review mode
- No license key required
Pro
$9 / month
- 1,000 syncs per month
- Private repositories
- Pull-request or auto-merge mode
- Gumroad license verified server-side
Questions before you add it
How is my repository data handled?
The git diff and current README are sent over HTTPS for processing only and are not retained on ReadmeForge servers. Customer code is never used to train models. Pro requests also include the license key needed for server-side verification.
Do I need an AI key?
No. ReadmeForge runs the AI docs-sync inside the hosted API, so your repository never needs an AI provider key.
Will it overwrite documentation without review?
Not by default. mode: pr creates a dedicated branch and pull request. Pro users can choose mode: commit for direct updates; protected branch rules still apply.
How do tiers and quotas work?
Free covers 20 syncs per month for public repositories in PR mode. Pro covers 1,000 syncs per month, private repositories, and commit mode. The API verifies the tier and enforces the quota before running AI.
How does Pro licensing work?
Buy Pro through Gumroad, then store the license key you receive as READMEFORGE_LICENSE_KEY and pass it through the Action’s optional license-key input. The API verifies it server-side.
What happens when there is nothing to update?
The Action compares the API response with the existing README. If they match, it exits cleanly without creating a branch, pull request, or commit.