Improve README
See original GitHub issueHello,
The README could add more information so that users know:
- that the package is published on npm. it could be done by displaying a section “Installation” and add the line
npm i react-player-controls
- how to import it and use it within an application. A line like
import { PlayButton, PauseButton, PrevButton, NextButton, PlaybackControls } from 'react-player-controls'
before the first examples should be enough.
I can submit a PR for it if you want?
Issue Analytics
- State:
- Created 7 years ago
- Comments:7 (7 by maintainers)
Top Results From Across the Web
10 useful sections to improve your Github README files
Today we are going to cover a list of 10 important sections you can add to your GitHub projects for improving your README...
Read more >How to Write a Good README File for Your GitHub Project
In this article, we'll learn more about what a README file is and how to ... There you have it, everything you need...
Read more >Improve README readability by froByte · Pull Request #639
Make important keywords italic Links are now parsed as links Highlights some specific words (e.g lib names, and directories)
Read more >Improve Readme [#3318832] | Drupal.org
Improving Readme File as suggested. We could be using README.md instead of README.txt to make use of the nicer rendering via markdown.
Read more >How To Improve Your WordPress Plugin's Readme.txt
If you're a plugin developer and you just love to write code, then writing a readme.txt file for a plugin in WordPress' repository...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
lol, such a british thing to say 😉
sure I can submit a quick PR