Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README #2

Open
17 of 19 tasks
adrianmcli opened this issue Dec 28, 2016 · 1 comment
Open
17 of 19 tasks

Improve README #2

adrianmcli opened this issue Dec 28, 2016 · 1 comment

Comments

@adrianmcli
Copy link
Owner

adrianmcli commented Dec 28, 2016 •
edited

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
@adrianmcli
Copy link
Owner Author

adrianmcli commented Dec 28, 2016 •
edited

Image should be replaced with a smaller file:
react-reveal-text

EDIT: done.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@adrianmcli