Improve README - Githubissues

adrianmcli / react-reveal-text

✨ A small react library for animating the revealing of text.

https://adrianmcli.github.io/react-reveal-text/

186 stars 14 forks source link

Improve README #2

Open adrianmcli opened 7 years ago

adrianmcli commented 7 years ago

See here for an example of a good, comprehensive, and well-designed README: https://github.com/clauderic/react-infinite-calendar

GitHub Short Description

[x] A short informative sentence for link previews
[x] Use an emoji in the description to get people's attention
[x] Add a link to a demo page

README.md

[ ] Have a nice logo
[x] Have an awesome image/animated gif
[x] Title of your project in plain Capitalized English
[x] Short description and link to demo page

Badges from Shields.io

[x] NPM version
[x] Build status (Travis/Circle CI)
[x] Dependencies
[x] Code quality (Bithound or similar)
[ ] Code coverage
[x] License

Features

[x] Use an emoji
[x] Have at least 4 or 5 features
[x] Keep the focus on simplicity, lightness (e.g. zero-dependency), and ease-of-use

Other Sections

[x] Getting Started or Installation + Usage
[x] API
[x] Contributing guidelines

adrianmcli commented 7 years ago

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

EDIT: done.