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
.editorconfigand contribution guide link for contributors