diff --git a/README.md b/README.md index 2c15ea3..b1bfab2 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,44 @@ + + # Timeoff Management for YunoHost -[![Integration level](https://dash.yunohost.org/integration/timeoff.svg)](https://dash.yunohost.org/appci/app/timeoff) ![](https://ci-apps.yunohost.org/ci/badges/timeoff.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/timeoff.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/timeoff.svg)](https://dash.yunohost.org/appci/app/timeoff) ![](https://ci-apps.yunohost.org/ci/badges/timeoff.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/timeoff.maintain.svg) +[![Install Timeoff Management with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=timeoff) -Upstream project : -- https://timeoff.management/ -- https://github.com/timeoff-management/application +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Timeoff Management 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 + +Web application for managing employee absences + +**Shipped version:** 1.3.3~ynh1 + +**Demo:** https://demo.example.com + +## Documentation and resources + +* Official app website: https://timeoff.management/ +* Official user documentation: https://yunohost.org/apps +* Official admin documentation: https://timeoff.management/support/main-page.html +* Upstream app code repository: https://github.com/timeoff-management/timeoff-management-application +* YunoHost documentation for this app: https://yunohost.org/app_timeoff +* Report a bug: https://github.com/YunoHost-Apps/timeoff_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/timeoff_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/timeoff_ynh/tree/testing --debug +or +sudo yunohost app upgrade timeoff -u https://github.com/YunoHost-Apps/timeoff_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..4251575 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,40 @@ +# Timeoff Management pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/timeoff.svg)](https://dash.yunohost.org/appci/app/timeoff) ![](https://ci-apps.yunohost.org/ci/badges/timeoff.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/timeoff.maintain.svg) +[![Installer Timeoff Management avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=timeoff) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Timeoff Management 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 + + + +**Version incluse :** 1.3.3~ynh1 + +**Démo :** https://demo.example.com + +## Documentations et ressources + +* Site officiel de l'app : https://timeoff.management/ +* Documentation officielle utilisateur : https://yunohost.org/apps +* Documentation officielle de l'admin : https://timeoff.management/support/main-page.html +* Dépôt de code officiel de l'app : https://github.com/timeoff-management/timeoff-management-application +* Documentation YunoHost pour cette app : https://yunohost.org/app_timeoff +* Signaler un bug : https://github.com/YunoHost-Apps/timeoff_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/timeoff_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/timeoff_ynh/tree/testing --debug +ou +sudo yunohost app upgrade timeoff -u https://github.com/YunoHost-Apps/timeoff_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file