Readme Crafting

Write README files that onboard users quickly — what, why, how, and where to get help.

RahulRachhoya Updated

File contents

README Crafting

Structure

# Project Name
[One-line description]

## Quick Start
[Copy-paste commands to get running]

## Usage
[Basic usage examples]

## API
[Link to full documentation]

## Development
[How to set up dev environment, run tests, build]

## Contributing
[How to contribute — PR process, coding standards]

## License
[MIT, Apache 2.0, etc.]

Rules

  • The first paragraph must explain what the project does and why it exists
  • Quick start must be copy-paste runnable (test it!)
  • Use badges for CI status, version, license
  • Include a screenshot or GIF for visual projects
  • Link to detailed docs, don't duplicate them
  • Keep it updated — outdated README is worse than no README
  • Add a .editorconfig and contribution guide link for contributors

RahulRachhoya/auto-skill-mcp/tree/main/src/auto_skill_mcp/skill_data/readme-crafting commit 06473ab601

Frequently asked questions

npx skillmds@latest add rahulrachhoya/readme-crafting