diff --git a/README.md b/README.md index c506448..5c29954 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Transmission for YunoHost [![Integration level](https://dash.yunohost.org/integration/transmission.svg)](https://dash.yunohost.org/appci/app/transmission) ![](https://ci-apps.yunohost.org/ci/badges/transmission.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/transmission.maintain.svg) @@ -5,37 +10,22 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install Transmission quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install Transmission 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 -Transmission is a fast, easy, and free BitTorrent client. +A Fast, Easy, and Free BitTorrent Client -**Shipped version:** 2.94-2 (Debian repository version) +**Shipped version:** 2.94-2~ynh1 + +**Demo:** https://demo.example.com ## Screenshots -![](transmission.jpg) -## Configuration +![](./doc/screenshots/transmission.jpg) -## Documentation - - * Official documentation: https://github.com/transmission/transmission/wiki - * YunoHost documentation: https://yunohost.org/en/app_transmission - -## YunoHost specific features - - * Integration with YunoHost Multimedia directories - -#### Multi-users support - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/transmission.svg)](https://ci-apps.yunohost.org/ci/apps/transmission/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/transmission.svg)](https://ci-apps-arm.yunohost.org/ci/apps/transmission/) - -## Limitations +## Disclaimers / important information ## Additionnal informations Alternative to WebUI : @@ -55,18 +45,18 @@ You can use the following information to connect your server: * Password: Password of the Yunohost User above * RPC Path: /torrent/transmission/rpc (if you used the standard folder) -## Links +## Documentation and resources - * Report a bug: https://github.com/YunoHost-Apps/transmission_ynh/issues - * Transmission website: https://transmissionbt.com/ - * Transmission repository: https://github.com/transmission/transmission - * YunoHost website: https://yunohost.org/ +* Official app website: https://www.transmissionbt.com/ +* Official user documentation: https://yunohost.org/en/app_transmission +* Official admin documentation: https://github.com/transmission/transmission/wiki +* Upstream app code repository: https://github.com/transmission/transmission +* YunoHost documentation for this app: https://yunohost.org/app_transmission +* Report a bug: https://github.com/YunoHost-Apps/transmission_ynh/issues ---- +## Developer info -## Developers infos - -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/transmission_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/transmission_ynh/tree/testing). To try the testing branch, please proceed like that. ``` @@ -74,3 +64,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/transmission_ynh/tree or sudo yunohost app upgrade transmission -u https://github.com/YunoHost-Apps/transmission_ynh/tree/testing --debug ``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md index a1366da..d3e5531 100644 --- a/README_fr.md +++ b/README_fr.md @@ -3,39 +3,25 @@ [![Niveau d'intégration](https://dash.yunohost.org/integration/transmission.svg)](https://dash.yunohost.org/appci/app/transmission) ![](https://ci-apps.yunohost.org/ci/badges/transmission.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/transmission.maintain.svg) [![Installer Transmission avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=transmission) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Transmission rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Transmission 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 -Transmission est un client BitTorrent libre, efficace et simple. +Un client BitTorrent libre et rapide -**Version incluse :** 2.94-2 (La version du dépôt de Debian) +**Version incluse :** 2.94-2~ynh1 + +**Démo :** https://demo.example.com ## Captures d'écran -![](transmission.jpg) -## Configuration +![](./doc/screenshots/transmission.jpg) -## Documentation - - * Documentation officielle : https://github.com/transmission/transmission/wiki - * Documentation YunoHost : https://yunohost.org/fr/app_transmission - -## Caractéristiques spécifiques YunoHost - - * Intégration avec les répertoires Multimédias de YunoHost - -#### Support multi-utilisateur - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/transmission.svg)](https://ci-apps.yunohost.org/ci/apps/transmission/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/transmission.svg)](https://ci-apps-arm.yunohost.org/ci/apps/transmission/) - -## Limitations +## Avertissements / informations importantes ## Informations additionnelles Alternative à WebUI : @@ -55,13 +41,14 @@ Vous pouvez utiliser les informations suivantes pour vous connecter à votre ser * Mot de passe : Le mot de passe de l'utilisateur YunoHost utilisé * Répertoire RPC : `/torrent/transmission/rpc` (si vous utilisez le répertoire par défaut) -## Liens - * Signaler un bug : https://github.com/YunoHost-Apps/transmission_ynh/issues - * Site de Transmission : https://transmissionbt.com/ - * Dépôt de Transmission : https://github.com/transmission/transmission - * Site de YunoHost : https://yunohost.org/ +## Documentations et ressources ---- +* Site officiel de l'app : https://www.transmissionbt.com/ +* Documentation officielle utilisateur : https://yunohost.org/en/app_transmission +* Documentation officielle de l'admin : https://github.com/transmission/transmission/wiki +* Dépôt de code officiel de l'app : https://github.com/transmission/transmission +* Documentation YunoHost pour cette app : https://yunohost.org/app_transmission +* Signaler un bug : https://github.com/YunoHost-Apps/transmission_ynh/issues ## Informations pour les développeurs @@ -73,3 +60,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/transmission_ynh/tree ou sudo yunohost app upgrade transmission -u https://github.com/YunoHost-Apps/transmission_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file