diff --git a/README.md b/README.md index c0d57d9..0f52c6c 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,8 @@ It shall NOT be edited by hand. # Etherpad for YunoHost -[![Integration level](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![Working status](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg) + [![Install Etherpad with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad) *[Lire ce readme en français.](./README_fr.md)* @@ -24,7 +25,7 @@ Etherpad is a real-time collaborative editor scalable to thousands of simultaneo ## Screenshots -![](./doc/screenshots/etherpad.gif) +![Screenshot of Etherpad](./doc/screenshots/etherpad.gif) ## Disclaimers / important information @@ -43,21 +44,22 @@ You can access Etherpad's admin panel at `domain.tld/admin`. The configuration f ## Documentation and resources -* Official app website: https://etherpad.org/ -* Official admin documentation: http://etherpad.org/doc/v1.8.17 -* Upstream app code repository: https://github.com/ether/etherpad-lite -* YunoHost documentation for this app: https://yunohost.org/app_etherpad -* Report a bug: https://github.com/YunoHost-Apps/etherpad_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/etherpad_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug or sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_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 7903fc4..3c65699 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,15 +1,20 @@ + + # Etherpad pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg) +[![Niveau d’intégration](https://dash.yunohost.org/integration/etherpad.svg)](https://dash.yunohost.org/appci/app/etherpad) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/etherpad.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/etherpad.maintain.svg) + [![Installer Etherpad avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=etherpad) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Etherpad 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 Etherpad 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 Etherpad est un éditeur collaboratif en temps réel évolutif pour des milliers d'utilisateurs simultanés en temps réel. Il fournit des capacités complètes d'exportation de données et s'exécute sur votre serveur, sous votre contrôle. @@ -17,9 +22,9 @@ Etherpad est un éditeur collaboratif en temps réel évolutif pour des milliers **Démo :** https://video.etherpad.com/ -## Captures d'écran +## Captures d’écran -![](./doc/screenshots/etherpad.gif) +![Capture d’écran de Etherpad](./doc/screenshots/etherpad.gif) ## Avertissements / informations importantes @@ -31,21 +36,22 @@ Vous pouvez accéder au panneau d'administration d'Etherpad à l'adresse `domain ## Documentations et ressources -* Site officiel de l'app : https://etherpad.org/ -* Documentation officielle de l'admin : http://etherpad.org/doc/v1.8.17 -* Dépôt de code officiel de l'app : https://github.com/ether/etherpad-lite -* Documentation YunoHost pour cette app : https://yunohost.org/app_etherpad -* Signaler un bug : https://github.com/YunoHost-Apps/etherpad_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/etherpad_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/etherpad_ynh/tree/testing --debug ou sudo yunohost app upgrade etherpad -u https://github.com/YunoHost-Apps/etherpad_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