diff --git a/README.md b/README.md index 1ab7c95..d5ca170 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # PufferPanel for YunoHost -[![Integration level](https://dash.yunohost.org/integration/pufferpanel.svg)](https://dash.yunohost.org/appci/app/pufferpanel) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/pufferpanel.svg)](https://dash.yunohost.org/appci/app/pufferpanel) ![Working status](https://ci-apps.yunohost.org/ci/badges/pufferpanel.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/pufferpanel.maintain.svg) [![Install PufferPanel with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pufferpanel) *[Lire ce readme en français.](./README_fr.md)* @@ -15,36 +15,35 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Web-based Game Server Management System. +PufferPanel is an open source game server management panel designed to be easy to use and easy to install. PufferPanel supports Minecraft, Forge, Spigot, Sponge, Source Dedicated Servers, BungeeCord, PocketMine, Forge, and much more. **Shipped version:** 2.4.0~ynh1 - - ## Screenshots -![](./doc/screenshots/serverlist.png) +![Screenshot of PufferPanel](./doc/screenshots/serverlist.png) ## Disclaimers / important information -- Admin username minimum length is 5 +- Admin username minimum length is five characters. ## Documentation and resources -* Official app website: https://www.pufferpanel.com/ -* Official admin documentation: https://docs.pufferpanel.com/en/latest/ -* Upstream app code repository: https://github.com/PufferPanel/PufferPanel -* YunoHost documentation for this app: https://yunohost.org/app_pufferpanel -* Report a bug: https://github.com/YunoHost-Apps/pufferpanel_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/pufferpanel_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing --debug or sudo yunohost app upgrade pufferpanel -u https://github.com/YunoHost-Apps/pufferpanel_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 7a499bc..2751be8 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,46 +1,49 @@ + + # PufferPanel pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/pufferpanel.svg)](https://dash.yunohost.org/appci/app/pufferpanel) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pufferpanel.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/pufferpanel.svg)](https://dash.yunohost.org/appci/app/pufferpanel) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/pufferpanel.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/pufferpanel.maintain.svg) [![Installer PufferPanel avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pufferpanel) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer PufferPanel 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 - +PufferPanel is an open source game server management panel designed to be easy to use and easy to install. PufferPanel supports Minecraft, Forge, Spigot, Sponge, Source Dedicated Servers, BungeeCord, PocketMine, Forge, and much more. **Version incluse :** 2.4.0~ynh1 - - ## Captures d'écran -![](./doc/screenshots/serverlist.png) +![Capture d'écran de PufferPanel](./doc/screenshots/serverlist.png) ## Avertissements / informations importantes -- Admin username minimum length is 5 +- Admin username minimum length is five characters. ## Documentations et ressources -* Site officiel de l'app : https://www.pufferpanel.com/ -* Documentation officielle de l'admin : https://docs.pufferpanel.com/en/latest/ -* Dépôt de code officiel de l'app : https://github.com/PufferPanel/PufferPanel -* Documentation YunoHost pour cette app : https://yunohost.org/app_pufferpanel -* Signaler un bug : https://github.com/YunoHost-Apps/pufferpanel_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/pufferpanel_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/pufferpanel_ynh/tree/testing --debug ou sudo yunohost app upgrade pufferpanel -u https://github.com/YunoHost-Apps/pufferpanel_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 :**