YunoHost-Apps/piped_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/piped_ynh.git synced 2024-09-03 20:05:54 +02:00
Code Issues Activity Actions

Merge pull request #3 from orhtej2/update_readme

Browse source 
Autogenerated README
This commit is contained in:
Mateusz 2024-01-28 21:09:08 +01:00 • committed by GitHub
commit c2b06540c0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 176 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

89
README.md
View file

@ -1 +1,88 @@
# piped_ynh <!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# 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: <https://docs.piped.video/>
* Official admin documentation: <https://docs.piped.video/docs/>
* Upstream app code repository: <https://github.com/TeamPiped/Piped>
* YunoHost Store: <https://apps.yunohost.org/app/piped>
* Report a bug: <https://github.com/YunoHost-Apps/piped_ynh/issues>
## 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:** <https://yunohost.org/packaging_apps>

88
README_fr.md Normal file
View file

@ -0,0 +1,88 @@
<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# 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 : <https://docs.piped.video/>
* Documentation officielle de l’admin : <https://docs.piped.video/docs/>
* Dépôt de code officiel de l’app : <https://github.com/TeamPiped/Piped>
* YunoHost Store: <https://apps.yunohost.org/app/piped>
* Signaler un bug : <https://github.com/YunoHost-Apps/piped_ynh/issues>
## 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 :** <https://yunohost.org/packaging_apps>