diff --git a/README.md b/README.md index 5e0cdce..1a032f6 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,47 @@ -coin_ynh -=============== + -Coin for YunoHost +# Coin for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/coin.svg)](https://dash.yunohost.org/appci/app/coin) ![](https://ci-apps.yunohost.org/ci/badges/coin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coin.maintain.svg) +[![Install Coin with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=coin) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Coin 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 + +COIN is an Information System designed for associative ISPs in the FFDN. -More information on https://code.ffdn.org/FFDN/coin +**Shipped version:** 20200630~ynh1 -## Install + +## Screenshots + +![](./doc/screenshots/user-subscriptions.png) + +## Documentation and resources + +* Official app website: https://code.ffdn.org/FFDN/coin +* Upstream app code repository: https://code.ffdn.org/ffdn/coin +* YunoHost documentation for this app: https://yunohost.org/app_coin +* Report a bug: https://github.com/YunoHost-Apps/coin_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/coin_ynh/tree/testing). + +To try the testing branch, please proceed like that. ``` -yunohost app install https://github.com/YunoHost-Apps/coin_ynh -a "domain=adherents.arn-fai.net&path=/&email=contact@arn-fai.net&isp_name=ARN&isp_site=//arn-fai.net&admin=ljf" +sudo yunohost app install https://github.com/YunoHost-Apps/coin_ynh/tree/testing --debug +or +sudo yunohost app upgrade coin -u https://github.com/YunoHost-Apps/coin_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..3d46e4d --- /dev/null +++ b/README_fr.md @@ -0,0 +1,43 @@ +# Coin pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/coin.svg)](https://dash.yunohost.org/appci/app/coin) ![](https://ci-apps.yunohost.org/ci/badges/coin.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/coin.maintain.svg) +[![Installer Coin avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=coin) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Coin 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 + +COIN is an Information System designed for associative ISPs in the FFDN. + + +**Version incluse :** 20200630~ynh1 + + + +## Captures d'écran + +![](./doc/screenshots/user-subscriptions.png) + +## Documentations et ressources + +* Site officiel de l'app : https://code.ffdn.org/FFDN/coin +* Dépôt de code officiel de l'app : https://code.ffdn.org/ffdn/coin +* Documentation YunoHost pour cette app : https://yunohost.org/app_coin +* Signaler un bug : https://github.com/YunoHost-Apps/coin_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/coin_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/coin_ynh/tree/testing --debug +ou +sudo yunohost app upgrade coin -u https://github.com/YunoHost-Apps/coin_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file