From 43856e1e81327e0681dafae0148fba77ef3203bf Mon Sep 17 00:00:00 2001 From: orhtej2 <2871798+orhtej2@users.noreply.github.com> Date: Sun, 28 Jan 2024 21:01:19 +0100 Subject: [PATCH] Autogenerated README --- README.md | 89 +++++++++++++++++++++++++++++++++++++++++++++++++++- README_fr.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 176 insertions(+), 1 deletion(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 94e164d..77c03d3 100644 --- a/README.md +++ b/README.md @@ -1 +1,88 @@ -# piped_ynh \ No newline at end of file + + +# Piped for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/piped.svg)](https://dash.yunohost.org/appci/app/piped) ![Working status](https://ci-apps.yunohost.org/ci/badges/piped.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/piped.maintain.svg) + +[![Install Piped with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=piped) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Piped quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* + +## Overview + +# The Problem + +YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think. + +By using Piped, you can freely watch and listen to content without the fear of prying eyes watching everything you are doing. + +## Features: + +**User Features** + +- [x] No Ads +- [x] No Tracking +- [x] Lightweight on server and client +- [x] Infinite Scrolling +- [x] Light/Dark themes +- [x] Login +- [x] Feeds +- [x] Playlists +- [x] Integration with [SponsorBlock](https://github.com/ajayyy/SponsorBlock) +- [x] Integration with [LBRY](https://lbry.com/) for streaming +- [x] Integration with [Return YouTube Dislike](https://returnyoutubedislike.com/) via [RYD-Proxy](https://github.com/TeamPiped/RYD-Proxy) +- [x] 4K support +- [x] No connections to Google's servers +- [x] Playing just audio +- [x] PWA support +- [x] Locally saved Preferences +- [x] [Available in many languages](src/locales), thanks to [our translators](https://hosted.weblate.org/projects/piped/frontend/) +- [x] Embedded video support +- [x] No age restriction +- [x] Bypasses Geo restrictions if possible through a federated network + +**Technical Features** + +- [x] Multi-region load-balancing +- [x] Performant by design, designed to handle 1000s of users concurrently +- [x] Does not use official YouTube APIs +- [x] Uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to extract information +- [x] Public [JSON API](https://docs.piped.video/docs/api-documentation/) +- [x] Federated protocol on Matrix to let instances collaborate with each other + +**Shipped version:** 2024.01.21~ynh1 + +**Demo:** https://piped.video/ + +## Screenshots + +![Screenshot of Piped](./doc/screenshots/channel.png) +![Screenshot of Piped](./doc/screenshots/player.png) + +## Documentation and resources + +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost Store: +* Report a bug: + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/piped_ynh/tree/testing). + +To try the testing branch, please proceed like that. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug +or +sudo yunohost app upgrade piped -u https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..5ce7c25 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,88 @@ + + +# Piped pour YunoHost + +[![Niveau d’intégration](https://dash.yunohost.org/integration/piped.svg)](https://dash.yunohost.org/appci/app/piped) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/piped.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/piped.maintain.svg) + +[![Installer Piped avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=piped) + +*[Read this readme in english.](./README.md)* + +> *Ce package vous permet d’installer Piped rapidement et simplement sur un serveur YunoHost. +Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.* + +## Vue d’ensemble + +# The Problem + +YouTube has an extremely invasive privacy policy which relies on using user data in unethical ways. You give them a lot of data - ranging from ideas, music taste, content, political opinions, and much more than you think. + +By using Piped, you can freely watch and listen to content without the fear of prying eyes watching everything you are doing. + +## Features: + +**User Features** + +- [x] No Ads +- [x] No Tracking +- [x] Lightweight on server and client +- [x] Infinite Scrolling +- [x] Light/Dark themes +- [x] Login +- [x] Feeds +- [x] Playlists +- [x] Integration with [SponsorBlock](https://github.com/ajayyy/SponsorBlock) +- [x] Integration with [LBRY](https://lbry.com/) for streaming +- [x] Integration with [Return YouTube Dislike](https://returnyoutubedislike.com/) via [RYD-Proxy](https://github.com/TeamPiped/RYD-Proxy) +- [x] 4K support +- [x] No connections to Google's servers +- [x] Playing just audio +- [x] PWA support +- [x] Locally saved Preferences +- [x] [Available in many languages](src/locales), thanks to [our translators](https://hosted.weblate.org/projects/piped/frontend/) +- [x] Embedded video support +- [x] No age restriction +- [x] Bypasses Geo restrictions if possible through a federated network + +**Technical Features** + +- [x] Multi-region load-balancing +- [x] Performant by design, designed to handle 1000s of users concurrently +- [x] Does not use official YouTube APIs +- [x] Uses [NewPipeExtractor](https://github.com/TeamNewPipe/NewPipeExtractor) to extract information +- [x] Public [JSON API](https://docs.piped.video/docs/api-documentation/) +- [x] Federated protocol on Matrix to let instances collaborate with each other + +**Version incluse :** 2024.01.21~ynh1 + +**Démo :** https://piped.video/ + +## Captures d’écran + +![Capture d’écran de Piped](./doc/screenshots/channel.png) +![Capture d’écran de Piped](./doc/screenshots/player.png) + +## Documentations et ressources + +* Site officiel de l’app : +* Documentation officielle de l’admin : +* Dépôt de code officiel de l’app : +* YunoHost Store: +* Signaler un bug : + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/piped_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. + +``` bash +sudo yunohost app install https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug +ou +sudo yunohost app upgrade piped -u https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug +``` + +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file