Add badges, install steps, usage examples, and license. Copy markdown straight into your repo.
10+ badge typesLive previewMarkdown output
Project info
Badges
Features
Installation & usage
Use {package} as placeholder for project name
License & author
README.mdmarkdown
# Project Name
## Installation
```bash
npm install your-package
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
1. Fork the project
2. Create your feature branch (`git checkout -b feature/AmazingFeature`)
3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
## License
This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.
Want more than a README?
Dokly gives you a full docs site with MDX, search, and analytics — starting free.