Readme generator free

Skill justhandledlabs/skills/skills/readme-generator-free

Free agent skills for Claude Code and SKILL.md agents. Add with: /plugin marketplace add justhandledlabs/skills. Eleven focused tools by JustHandled Labs.

Install

npx -y skills add justhandledlabs/skills --skill readme-generator-free

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

One thing to look at

0 stars0 stars. Stars are a popularity signal and not a quality one, but at this level it is likely that nobody has read this closely except its author, and you would be relying on your own review.

What its author says it does

Copied from the file, not written here

Generate polished README files from project code. Use when the user says "generate readme", "create README", "write project documentation", "make a readme", or asks for README generation, project documentation, installation docs, usage docs, API docs, badges, or repository onboarding documentation derived from an existing codebase.

The file declares its own license as MIT. That is the author’s claim about this one file, and it is not the same thing as the license GitHub reports for the repository, which is listed with the other numbers below.

SKILL.md

4.1 KB, as published. Nobody here has run it

README Generator

Create a polished, accurate README.md from the project files that actually exist. Prefer evidence from manifests, source files, comments, and command output over generic filler.

Workflow

Inspect the project root before writing:
- Node: package.json
- Python: requirements.txt, pyproject.toml, setup.py, or setup.cfg
- Go: go.mod
- Rust: Cargo.toml
- Java: pom.xml, build.gradle, or build.gradle.kts
- Make commands: Makefile
- License: LICENSE, LICENSE.md, or package manifest license fields
Detect the main entry point:
- Node/TypeScript: package.json main, bin, exports, src/index.ts, src/index.js, index.js, or server.js
- Python: main.py, app.py, package console scripts, or __main__.py
- Go: main.go or cmd/*/main.go
- Rust: src/main.rs, src/lib.rs, or [[bin]] entries in Cargo.toml
- Java: Maven/Gradle application plugin config or src/main/java/**/Main.java
Extract dependencies only from actual manifests:
- Node: dependencies, devDependencies, peerDependencies, and optionalDependencies
- Python: requirements.txt, pyproject.toml, setup.py, or setup.cfg
- Go: require blocks in go.mod
- Rust: [dependencies], [dev-dependencies], and [build-dependencies]
- Java: Maven dependencies or Gradle dependencies
Extract scripts and commands:
- Node: package.json scripts
- Make: targets from Makefile
- Python: console scripts in package metadata, common commands from project files
- Go/Rust/Java: standard build, test, and run commands when the matching manifest exists
Infer description cautiously:
- Prefer package.json/manifest description fields.
- Otherwise use top-level comments, module docstrings, existing docs, or repository/folder name.
- If there is not enough evidence, write a modest one-sentence description and mark unknown specifics as TODO.
Generate the README with:
- Title from package name, manifest name, or directory name
- Badges for license, primary language, version, and build status placeholder
- Description
- Installation instructions for the detected language
- Usage examples from --help output when safe to run, otherwise from scripts and entry points
- API documentation when JSDoc, docstrings, Go comments, Rust doc comments, or JavaDoc are present
- Contributing guidelines
- License section from detected license or a prompt/TODO when unknown

Template Reference

Read references/templates.md when choosing language-specific README sections, badge patterns, or install command templates. Keep the final README tailored to the current repository rather than copying every optional section.

Accuracy Rules

Do not hallucinate dependencies, commands, entry points, environment variables, APIs, or deployment steps.
Only include dependencies and scripts that were found in real files.
Use TODO markers for important unknowns instead of inventing facts.
Do not run commands that mutate the project while collecting README evidence.
Only run --help commands when they are likely safe and local; skip them if the command may start servers, install packages, modify files, or call external services.
Keep Markdown valid with one # title, proper heading levels, fenced code blocks, and no broken table syntax.

Output Shape

When asked to create or update a README, write or update README.md in the project root unless the user specifies another path. Summarize the evidence used and list any TODOs that remain because the repository did not contain enough information.

Gives 0 of the 12 instructions most readme changelog skills give

Counted across 471 of the 478 authors here whose files we hold, read 2026-08-06

follow the Keep a Changelog formatin 31 of 471, across 26 files
omit empty sectionsin 21 of 471
Run from the git repository rootin 20 of 471, across 7 files
save output directly to CHANGELOG.mdin 20 of 471, across 7 files
Group commits into logical categoriesin 19 of 471, across 6 files
Review the generated changelog before publishingin 19 of 471, across 6 files
Apply changelog guidelines and brand voicein 18 of 471, across 5 files
Exclude internal commits like refactoring and testsin 18 of 471, across 5 files
Specify date ranges for focused changelogsin 17 of 471, across 4 files
Convert technical commits into customer languagein 17 of 471, across 4 files
group commits by conventional commit typein 14 of 471
insert new entry below unreleased sectionin 14 of 471

Said here and by no other author read

Inspect project manifests before writing
Detect the main entry point
Extract dependencies from manifests
Infer description from evidence
Use TODO markers for unknowns
Keep Markdown valid

Grouped from the skills themselves: near-identical wordings counted once, and counted by distinct author, so one author publishing three of these counts once.