diff --git a/ALL_README.md b/ALL_README.md index e69de29..a01b345 100644 --- a/ALL_README.md +++ b/ALL_README.md @@ -0,0 +1,7 @@ +# 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) +- [Le o README en galego](README_gl.md) +- [阅读中文(简体)的 README](README_zh_Hans.md) diff --git a/README.md b/README.md index e69de29..2b0f1e4 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,46 @@ + + +# Jackett for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/jackett.svg)](https://dash.yunohost.org/appci/app/jackett) ![Working status](https://ci-apps.yunohost.org/ci/badges/jackett.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/jackett.maintain.svg) + +[![Install Jackett with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jackett) + +*[Read this README in other languages.](./ALL_README.md)* + +> *This package allows you to install Jackett 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 + +Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. + + +**Shipped version:** 0.21.2371~ynh1 + +## Screenshots + +![Screenshot of Jackett](./doc/screenshots/demo.png) + +## Documentation and resources + +- 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/jackett_ynh/tree/testing). + +To try the `testing` branch, please proceed like that: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug +or +sudo yunohost app upgrade jackett -u https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index e69de29..8fe7443 100644 --- a/README_fr.md +++ b/README_fr.md @@ -0,0 +1,46 @@ + + +# Jackett pour YunoHost + +[![Niveau d’intégration](https://dash.yunohost.org/integration/jackett.svg)](https://dash.yunohost.org/appci/app/jackett) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/jackett.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/jackett.maintain.svg) + +[![Installer Jackett avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jackett) + +*[Lire le README dans d'autres langues.](./ALL_README.md)* + +> *Ce package vous permet d’installer Jackett 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 + +Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. + + +**Version incluse :** 0.21.2371~ynh1 + +## Captures d’écran + +![Capture d’écran de Jackett](./doc/screenshots/demo.png) + +## Documentations et ressources + +- 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/jackett_ynh/tree/testing). + +Pour essayer la branche `testing`, procédez comme suit : + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug +ou +sudo yunohost app upgrade jackett -u https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug +``` + +**Plus d’infos sur le packaging d’applications :** diff --git a/README_gl.md b/README_gl.md index e69de29..b4cf187 100644 --- a/README_gl.md +++ b/README_gl.md @@ -0,0 +1,46 @@ + + +# Jackett para YunoHost + +[![Nivel de integración](https://dash.yunohost.org/integration/jackett.svg)](https://dash.yunohost.org/appci/app/jackett) ![Estado de funcionamento](https://ci-apps.yunohost.org/ci/badges/jackett.status.svg) ![Estado de mantemento](https://ci-apps.yunohost.org/ci/badges/jackett.maintain.svg) + +[![Instalar Jackett con YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=jackett) + +*[Le este README en outros idiomas.](./ALL_README.md)* + +> *Este paquete permíteche instalar Jackett de xeito rápido e doado nun servidor YunoHost.* +> *Se non usas YunoHost, le a [documentación](https://yunohost.org/install) para saber como instalalo.* + +## Vista xeral + +Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious etc.) into tracker-site-specific http queries, parses the html or json response, and then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. + + +**Versión proporcionada:** 0.21.2371~ynh1 + +## Capturas de pantalla + +![Captura de pantalla de Jackett](./doc/screenshots/demo.png) + +## Documentación e recursos + +- Repositorio de orixe do código: +- Tenda YunoHost: +- Informar dun problema: + +## Info de desenvolvemento + +Envía a túa colaboración á [rama `testing`](https://github.com/YunoHost-Apps/jackett_ynh/tree/testing). + +Para probar a rama `testing`, procede deste xeito: + +```bash +sudo yunohost app install https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug +ou +sudo yunohost app upgrade jackett -u https://github.com/YunoHost-Apps/jackett_ynh/tree/testing --debug +``` + +**Máis info sobre o empaquetado da app:**