AgentStack
Sign in Publish
MCP servers Skills Toolkits Why AgentStack Sell Docs
Sign in
SKILL verified MIT Self-run

Readme Generator

skill-sourav15mukherjee-skillforge-free-skills-readme-generator · by sourav15mukherjee

>-

↗ Repository
— No reviews yet
0 installs
13 views
0.0% view→install

Install

$ agentstack add skill-sourav15mukherjee-skillforge-free-skills-readme-generator

✓ scanned · ✓ verified — works with Claude Code, Cursor, and more.

Security review

✓ Passed

No issues found. Passed automated security review. · v0.1.0 How review works →

  • ✓ Prompt-injection patterns
  • ✓ Secret / credential exfiltration
  • ✓ Dangerous shell & filesystem operations
  • ✓ Untrusted network calls
  • ✓ Known-malicious package signatures

What it can access

  • ✓ Network access No
  • ✓ Filesystem access No
  • ✓ Shell / process execution No
  • ✓ Environment & secrets No
  • ✓ Dynamic code execution No

From automated source analysis of v0.1.0. “Used” means the capability is present in the source — more access means more to trust, not that it’s unsafe.

Are you the author of Readme Generator? Claim this listing to set pricing, connect Stripe payouts, and keep 70% of every sale.
Sign up to claim

About

README Generator

Analyze a project's structure, tech stack, and code to generate a comprehensive, well-organized README.md.

Workflow

  1. Scan the project structure

``bash find . -maxdepth 3 -not -path "*/node_modules/*" -not -path "*/.git/*" -not -path "*/dist/*" | head -80 `` Identify the project type: Library, CLI Tool, Web Application, API Service, or Monorepo.

  1. Detect the tech stack

Read config files (package.json, tsconfig.json, pyproject.toml, go.mod, Cargo.toml, Dockerfile). Extract: language, framework, test runner, linter, bundler, deployment target.

  1. Identify key entry points and exports

Read main source files to understand what the project does — exported functions, CLI commands, API endpoints.

  1. Extract existing documentation hints

Look for JSDoc/docstrings, existing partial README, CHANGELOG, LICENSE, CONTRIBUTING.

  1. Generate the README with these sections:
  • Title and Badges (license, language, version, CI status)
  • Description (2-3 sentences)
  • Features (bulleted key capabilities)
  • Prerequisites (runtime versions, required accounts)
  • Installation (actual commands from package.json scripts)
  • Configuration (environment variables, config files)
  • Usage (real code examples matching the actual API)
  • API Reference (if applicable — table of endpoints/functions)
  • Project Structure (key directories tree)
  • Scripts (table of npm/make commands)
  • Contributing (dev setup, testing, PR process)
  • License (type with link)
  1. Write the README

If a README exists, ask to replace or merge.

Rules

  • Always read actual source code — never guess at what the project does
  • Match README complexity to project size
  • Use real values (actual script names, actual dependencies, actual ports)
  • Include working code examples that reflect the actual API
  • If no tests exist, suggest adding them in Contributing
  • Keep tone professional but approachable
  • Do not include irrelevant sections (no API Reference for a CLI tool)

Source & license

This open-source skill is cataloged on AgentStack and links to its original source — we do not rehost the code.

Install and usage instructions live in the source repository linked above.

Reviews

No reviews yet — be the first.

Write a review

Versions

  • v0.1.0 Imported from the upstream source.

More in Agent Skills