diff --git a/README.md b/README.md index 60cd7f8..b37b1b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,41 @@ -# shuri_ynh + -ETAT: NE FONCTIONNE PAS ! +# shuri for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/shuri.svg)](https://dash.yunohost.org/appci/app/shuri) ![](https://ci-apps.yunohost.org/ci/badges/shuri.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/shuri.maintain.svg) +[![Install shuri with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shuri) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install shuri 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 + + + +**Shipped version:** 1.0~ynh1 + + + +## Documentation and resources + +* Upstream app code repository: https://github.com/pips-/shuri +* YunoHost documentation for this app: https://yunohost.org/app_shuri +* Report a bug: https://github.com/YunoHost-Apps/shuri_ynh/issues + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/shuri_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/shuri_ynh/tree/testing --debug +or +sudo yunohost app upgrade shuri -u https://github.com/YunoHost-Apps/shuri_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..e4a9bda --- /dev/null +++ b/README_fr.md @@ -0,0 +1,37 @@ +# shuri pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/shuri.svg)](https://dash.yunohost.org/appci/app/shuri) ![](https://ci-apps.yunohost.org/ci/badges/shuri.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/shuri.maintain.svg) +[![Installer shuri avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=shuri) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer shuri 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 + +Racourcisseur d'URL + +**Version incluse :** 1.0~ynh1 + + + +## Documentations et ressources + +* Dépôt de code officiel de l'app : https://github.com/pips-/shuri +* Documentation YunoHost pour cette app : https://yunohost.org/app_shuri +* Signaler un bug : https://github.com/YunoHost-Apps/shuri_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/shuri_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/shuri_ynh/tree/testing --debug +ou +sudo yunohost app upgrade shuri -u https://github.com/YunoHost-Apps/shuri_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file