search

openzim / youtube

Create a ZIM file from a Youtube channel/username/playlist
GNU General Public License v3.0
43 stars 26 forks source link

Update README to reflect new scraper changes #269

Closed dan-niles closed 1 month ago

dan-niles commented 1 month ago

The current README.md needs to be updated to reflect the new scraper changes. Some of the issues I noticed are:

  1. https://github.com/openzim/youtube/blob/1ba45c384cd8296a550fce17fb5bd509dd7748c8/README.md?plain=1#L16-L17 We are no longer creating static HTML files, so this could be replaced by mentioning the new Vue.js UI.

  2. https://github.com/openzim/youtube/blob/1ba45c384cd8296a550fce17fb5bd509dd7748c8/README.md?plain=1#L27 All Javascript dependencies are handled through Yarn, so this line could be replaced with something mentioning Yarn.

  3. https://github.com/openzim/youtube/blob/1ba45c384cd8296a550fce17fb5bd509dd7748c8/README.md?plain=1#L44 The developer setup wiki link is broken. Probably should be replaced with https://github.com/openzim/_python-bootstrap/blob/main/docs/Developer-Setup.md.

  4. https://github.com/openzim/youtube/blob/1ba45c384cd8296a550fce17fb5bd509dd7748c8/README.md?plain=1#L86 --only_test_branding CLI argument doesn't exist anymore. This line should be removed.

dan-niles commented 1 month ago

https://github.com/openzim/youtube/blob/1ba45c384cd8296a550fce17fb5bd509dd7748c8/README.md?plain=1#L21 The policy link here is also not working. It should be replaced with https://github.com/openzim/_python-bootstrap/blob/main/docs/Policy.md