Clarify withMediaProps decorator usage

souporserious / react-media-player

React audio and video player.

https://souporserious.github.io/react-media-player/

ISC License

470 stars 100 forks source link

Clarify withMediaProps decorator usage #48

Closed ismay closed 6 years ago

ismay commented 6 years ago

This might be obvious to some, but it might be nice to clarify that components using the withMediaProps decorator only work when they're descendants of the <Media> component here.

Just a line explaining that would already be enough I think.

souporserious commented 6 years ago

Sorry about that! I can definitely see how that can be confusing. I updated the docs to hopefully mitigate the confusion around this. I'm hoping to have a proper docs site sometime this year to help even more with this. Please feel free to open a PR if you'd like to add more clarification. Thanks for filing an issue!

ismay commented 6 years ago

Cool! 👍 Thanks for the quick fix and the awesome library!