-
Notifications
You must be signed in to change notification settings - Fork 14
Open
Description
See here for an example of a good, comprehensive, and well-designed README: https://github.com/clauderic/react-infinite-calendar
GitHub Short Description
- A short informative sentence for link previews
- Use an emoji in the description to get people's attention
- Add a link to a demo page
README.md
- Have a nice logo
- Have an awesome image/animated gif
- Title of your project in plain Capitalized English
- Short description and link to demo page
Badges from Shields.io
- NPM version
- Build status (Travis/Circle CI)
- Dependencies
- Code quality (Bithound or similar)
- Code coverage
- License
Features
- Use an emoji
- Have at least 4 or 5 features
- Keep the focus on simplicity, lightness (e.g. zero-dependency), and ease-of-use
Other Sections
- Getting Started or Installation + Usage
- API
- Contributing guidelines
Metadata
Metadata
Assignees
Labels
No labels