diff --git a/README.md b/README.md index 4a05aae..5a6577d 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,44 @@ -# PHPLicenseWatcher app for YunoHost -PHPLicenseWatcher Server + -**Shipped version:** 1.9.2 +# PHPLicenseWatcher for YunoHost -- [Yunohost project](https://yunohost.org) -- [Mantis website](http://phplicensewatch.sourceforge.net) +[![Integration level](https://dash.yunohost.org/integration/phplicensewatcher.svg)](https://dash.yunohost.org/appci/app/phplicensewatcher) ![](https://ci-apps.yunohost.org/ci/badges/phplicensewatcher.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phplicensewatcher.maintain.svg) +[![Install PHPLicenseWatcher with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phplicensewatcher) -![]() +*[Lire ce readme en français.](./README_fr.md)* +> *This package allows you to install PHPLicenseWatcher 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.* -[![Install Mantis with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=phplicensewatcher) +## Overview -### Installing guide +A license manager - App can be installed by YunoHost **admin web-interface** or by **running following command**: +**Shipped version:** 1.9.2~ynh1 - $ sudo yunohost app install https://github.com/YunoHost-Apps/phplicensewatcher_ynh - -### Upgrade this package: +**Demo:** https://demo.example.com - $ sudo yunohost app upgrade mantis -u https://github.com/YunoHost-Apps/phplicensewatcher_ynh +## Documentation and resources +* Official app website: https://example.com +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://yunohost.org/packaging_apps +* Upstream app code repository: https://some.forge.com/example/example +* YunoHost documentation for this app: https://yunohost.org/app_phplicensewatcher +* Report a bug: https://github.com/YunoHost-Apps/phplicensewatcher_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/phplicensewatcher_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/phplicensewatcher_ynh/tree/testing --debug +or +sudo yunohost app upgrade phplicensewatcher -u https://github.com/YunoHost-Apps/phplicensewatcher_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 new file mode 100644 index 0000000..9224b3d --- /dev/null +++ b/README_fr.md @@ -0,0 +1,40 @@ +# PHPLicenseWatcher pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/phplicensewatcher.svg)](https://dash.yunohost.org/appci/app/phplicensewatcher) ![](https://ci-apps.yunohost.org/ci/badges/phplicensewatcher.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/phplicensewatcher.maintain.svg) +[![Installer PHPLicenseWatcher avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=phplicensewatcher) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer PHPLicenseWatcher 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 + +Un gestionnaire de licences + +**Version incluse :** 1.9.2~ynh1 + +**Démo :** https://demo.example.com + +## Documentations et ressources + +* Site officiel de l'app : https://example.com +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://yunohost.org/packaging_apps +* Dépôt de code officiel de l'app : https://some.forge.com/example/example +* Documentation YunoHost pour cette app : https://yunohost.org/app_phplicensewatcher +* Signaler un bug : https://github.com/YunoHost-Apps/phplicensewatcher_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/phplicensewatcher_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/phplicensewatcher_ynh/tree/testing --debug +ou +sudo yunohost app upgrade phplicensewatcher -u https://github.com/YunoHost-Apps/phplicensewatcher_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file