Improve README - Githubissues

alexanderwallin / react-player-controls

⏯ Dumb and (re)useful React components for media players.

ISC License

191 stars 35 forks source link

Closed vkammerer closed 8 years ago

vkammerer commented 8 years ago

Hello,

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?

alexanderwallin commented 8 years ago

Brilliant, go ahead!

alexanderwallin commented 8 years ago

It is not clear nor exemplified that you can put anything you want inside the components (children), and that the icons are just for default.

vkammerer commented 8 years ago

Indeed. Also, for the bottom part of the README, what do you think about:

renaming the "Development" section to "Contribute"
making three subsections "dev", "build" and "test" with the CLI commands tu run
adding a line that mentions that any PR should be open only if tests have passed locally
removing the last section about publishing, as it is solely the role of the maintainer, and that the README could be more directed at users and contributors.

alexanderwallin commented 8 years ago

I think this README will end up at Tate Modern one day. 😊

vkammerer commented 8 years ago

lol, such a british thing to say ;)

alexanderwallin commented 8 years ago

Do you want to PR those last four changes or should I?

vkammerer commented 8 years ago

sure I can submit a quick PR