README & Badges
Generate a README.md from the real project, proposing a diff first.
Steps
- Read the repo:
package.json(name, description, scripts, bin, deps), the entry points, config, license, and any existing docs. - Write the README: title + one-liner, a shields.io badge row (license, version, build, stack), Install, Usage (a real example inferred from the code), Scripts, and License.
- Propose a diff against any existing README; let the user choose what lands. Do not clobber hand-written prose.
Verify
- Commands in Install/Usage actually exist in
package.json. - Badge links resolve.
- Preview shape at https://readme.tools.drummerduck.com