diff --git a/ALL_README.md b/ALL_README.md new file mode 100644 index 0000000..3eeb161 --- /dev/null +++ b/ALL_README.md @@ -0,0 +1,5 @@ +# All available README files by language + +- [Read the README in English](README.md) +- [Irakurri README euskaraz](README_eu.md) +- [Lire le README en français](README_fr.md) diff --git a/README.md b/README.md index 5b9ef58..9698bba 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![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)* +*[Read this README in other languages.](./ALL_README.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.* +> *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 @@ -55,7 +55,8 @@ By using Piped, you can freely watch and listen to content without the fear of p - [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.03.18~ynh1 + +**Shipped version:** 2024.04.01~ynh1 **Demo:** @@ -78,9 +79,9 @@ By using Piped, you can freely watch and listen to content without the fear of p ## Developer info -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/piped_ynh/tree/testing). +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. +To try the `testing` branch, please proceed like that: ```bash sudo yunohost app install https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug diff --git a/README_eu.md b/README_eu.md new file mode 100644 index 0000000..84ed10b --- /dev/null +++ b/README_eu.md @@ -0,0 +1,92 @@ + + +# Piped YunoHost-erako + +[![Integrazio maila](https://dash.yunohost.org/integration/piped.svg)](https://dash.yunohost.org/appci/app/piped) ![Funtzionamendu egoera](https://ci-apps.yunohost.org/ci/badges/piped.status.svg) ![Mantentze egoera](https://ci-apps.yunohost.org/ci/badges/piped.maintain.svg) + +[![Instalatu Piped YunoHost-ekin](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=piped) + +*[Irakurri README hau beste hizkuntzatan.](./ALL_README.md)* + +> *Pakete honek Piped YunoHost zerbitzari batean azkar eta zailtasunik gabe instalatzea ahalbidetzen dizu.* +> *YunoHost ez baduzu, kontsultatu [gida](https://yunohost.org/install) nola instalatu ikasteko.* + +## Aurreikuspena + +# 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 + +**Paketatutako bertsioa:** 2024.04.01~ynh1 + +**Demoa:** + +## Pantaila-argazkiak + +![Piped(r)en pantaila-argazkia](./doc/screenshots/channel.png) +![Piped(r)en pantaila-argazkia](./doc/screenshots/player.png) + +## :red_circle: Ezaugarri zalantzagarriak + +- **Libreak ez diren sareko zerbitzuak**: Librea ez den sare-zerbitzu bat sustatzen du edo horren mende dago erabat. + +## Dokumentazioa eta baliabideak + +- Aplikazioaren webgune ofiziala: +- Administratzaileen dokumentazio ofiziala: +- Jatorrizko aplikazioaren kode-gordailua: +- YunoHost Denda: +- Eman errore baten berri: + +## Garatzaileentzako informazioa + +Bidali `pull request`a [`testing` abarrera](https://github.com/YunoHost-Apps/piped_ynh/tree/testing). + +`testing` abarra probatzeko, ondorengoa egin: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug +edo +sudo yunohost app upgrade piped -u https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug +``` + +**Informazio gehiago aplikazioaren paketatzeari buruz:** diff --git a/README_fr.md b/README_fr.md index d3bae95..359e839 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,6 +1,6 @@ # Piped pour YunoHost @@ -9,10 +9,10 @@ It shall NOT be edited by hand. [![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)* +*[Lire le README dans d'autres langues.](./ALL_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.* +> *Ce package vous permet d’installer Piped rapidement et simplement sur un serveur YunoHost.* +> *Si vous n’avez pas YunoHost, consultez [ce guide](https://yunohost.org/install) pour savoir comment l’installer et en profiter.* ## Vue d’ensemble @@ -55,9 +55,10 @@ By using Piped, you can freely watch and listen to content without the fear of p - [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.03.18~ynh1 -**Démo :** +**Version incluse :** 2024.04.01~ynh1 + +**Démo :** ## Captures d’écran @@ -66,21 +67,21 @@ By using Piped, you can freely watch and listen to content without the fear of p ## :red_circle: Anti-fonctionnalités -- **Services réseau non libres** : Promeut ou utilise des services réseau non libres. +- **Services réseau non libres**: Promeut ou utilise des services réseau non libres. ## 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 : +- 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). +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. +Pour essayer la branche `testing`, procédez comme suit : ```bash sudo yunohost app install https://github.com/YunoHost-Apps/piped_ynh/tree/testing --debug @@ -88,4 +89,4 @@ 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 :** +**Plus d’infos sur le packaging d’applications :**