stephane-r / HoloPlay

React-Native app using Invidious API for listening Youtube audio source.
https://holoplay.io
MIT License
174 stars 7 forks source link

Add some basic documentation #146

Closed mariobrostech closed 3 years ago

mariobrostech commented 3 years ago

Hello,

As someone who knows essentially nothing about Invidious besides some of the available frontends, I feel like it would be helpful to have a basic configuration tutorial listed in the repo's README or written in the GitHub Wiki and referenced in the README.

Would someone who knows a thing or two about Invidious from more of an API perspective be interested in doing this? It would be extremely helpful for newbies to Invidious and would probably give this app some more traction.

Thanks in advance for your consideration!

DWW256 commented 3 years ago

This. I can't figure out for the life of me whether I'm even supposed to locate the API token for my desired instance or generate my own, let alone where to find such a thing in the first place.

stephane-r commented 3 years ago

Hey 😃

Thank you for your proposal ! I will make a PR with an update of the README after the holidays.

I'll ping you 👍

mariobrostech commented 3 years ago

Awesome, thank you!

stephane-r commented 3 years ago

Hey guys,

I've add some informations about Invidious on README. Could you give me your opinion, do you have any other information in mind ?

https://github.com/stephane-r/HoloPlay/pull/153/files

Thank you !

DWW256 commented 3 years ago

👏👏 That's exactly what I was looking for!

mariobrostech commented 3 years ago

@stephane-r This is great, thank you!