diff --git a/README.md b/README.md index de43d02..2d80d21 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # Tor relay for YunoHost -[![Integration level](https://dash.yunohost.org/integration/torrelay.svg)](https://dash.yunohost.org/appci/app/torrelay) ![](https://ci-apps.yunohost.org/ci/badges/torrelay.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/torrelay.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/torrelay.svg)](https://dash.yunohost.org/appci/app/torrelay) ![Working status](https://ci-apps.yunohost.org/ci/badges/torrelay.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/torrelay.maintain.svg) + [![Install Tor relay with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=torrelay) *[Lire ce readme en français.](./README_fr.md)* @@ -17,31 +18,30 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in The Tor network relies on volunteers to donate bandwidth. The more people who run relays, the better the Tor network will be. The current Tor network is quite small compared to the number of people who need to use Tor, which means we need more dedicated volunteers like you to run relays. -**Shipped version:** 0.4.6.10~ynh1 - - +**Shipped version:** 0.4.6.10~ynh2 ## Screenshots -![](./doc/screenshots/example.jpg) +![Screenshot of Tor relay](./doc/screenshots/example.jpg) ## Documentation and resources -* Official app website: https://www.torproject.org/ -* Official admin documentation: https://community.torproject.org/relay/setup/bridge/debian-ubuntu/ -* Upstream app code repository: https://github.com/torproject/tor -* YunoHost documentation for this app: https://yunohost.org/app_torrelay -* Report a bug: https://github.com/YunoHost-Apps/torrelay_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/torrelay_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/torrelay_ynh/tree/testing --debug or sudo yunohost app upgrade torrelay -u https://github.com/YunoHost-Apps/torrelay_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index d26385e..46caba3 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,43 +1,47 @@ + + # Tor relay pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/torrelay.svg)](https://dash.yunohost.org/appci/app/torrelay) ![](https://ci-apps.yunohost.org/ci/badges/torrelay.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/torrelay.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/torrelay.svg)](https://dash.yunohost.org/appci/app/torrelay) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/torrelay.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/torrelay.maintain.svg) + [![Installer Tor relay avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=torrelay) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Tor relay 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 Tor relay 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 +## Vue d’ensemble The Tor network relies on volunteers to donate bandwidth. The more people who run relays, the better the Tor network will be. The current Tor network is quite small compared to the number of people who need to use Tor, which means we need more dedicated volunteers like you to run relays. -**Version incluse :** 0.4.6.10~ynh1 +**Version incluse :** 0.4.6.10~ynh2 +## Captures d’écran - -## Captures d'écran - -![](./doc/screenshots/example.jpg) +![Capture d’écran de Tor relay](./doc/screenshots/example.jpg) ## Documentations et ressources -* Site officiel de l'app : https://www.torproject.org/ -* Documentation officielle de l'admin : https://community.torproject.org/relay/setup/bridge/debian-ubuntu/ -* Dépôt de code officiel de l'app : https://github.com/torproject/tor -* Documentation YunoHost pour cette app : https://yunohost.org/app_torrelay -* Signaler un bug : https://github.com/YunoHost-Apps/torrelay_ynh/issues +* Site officiel de l’app : +* Documentation officielle de l’admin : +* Dépôt de code officiel de l’app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/torrelay_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/torrelay_ynh/tree/testing --debug ou sudo yunohost app upgrade torrelay -u https://github.com/YunoHost-Apps/torrelay_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d’infos sur le packaging d’applications :** \ No newline at end of file