From 3614cf25c58c3e7b3877889ca04ef063751ec3a9 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot Date: Thu, 5 Aug 2021 21:42:47 +0000 Subject: [PATCH] Auto-update README --- README.md | 70 ++++++++++++++++++++-------------------------------- README_fr.md | 50 +++++++++++++++++++++++++++++++++++++ 2 files changed, 77 insertions(+), 43 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 140c5a2..0f26b81 100644 --- a/README.md +++ b/README.md @@ -1,62 +1,44 @@ -# Pepettes app for YunoHost + + +# Pepettes for YunoHost [![Integration level](https://dash.yunohost.org/integration/pepettes.svg)](https://dash.yunohost.org/appci/app/pepettes) ![](https://ci-apps.yunohost.org/ci/badges/pepettes.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pepettes.maintain.svg) -[![Install pepettes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pepettes) +[![Install Pepettes with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pepettes) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install pepettes quickly and simply on a YunoHost server. +> *This package allows you to install Pepettes 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 -Pepettes is a donation form based on Stripe. -**Shipped version:** 1.0 +A simple donation form with stripe -## Screenshots +**Shipped version:** 1.0.1~ynh1 -(none yet) +**Demo:** https://donate.yunohost.org -## Demo +## Disclaimers / important information -* [Official demo](https://donate.yunohost.org) +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * requiring a full dedicated domain ? + * architectures not supported ? + * not-working single-sign on or LDAP integration ? + * the app requires an important amount of RAM / disk / .. to install or to work properly + * etc... -## Configuration +* Other infos that people should be aware of, such as: + * How to configure this app: During the installation, or in `settings.py` after installation. -How to configure this app: During the installation, or in `settings.py` after installation. +## Documentation and resources -## Documentation - - * Official documentation: https://github.com/YunoHost/pepettes/blob/main/README.md - * YunoHost documentation: - - -## YunoHost specific features - -#### Multi-user support - -Are LDAP and HTTP auth supported? n/a -Can the app be used by multiple users? yes - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/pepettes%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/pepettes/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/pepettes%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/pepettes/) - -## Limitations - -(none) - -## Additional information - -(none) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/pepettes_ynh/issues - * Upstream app repository: https://github.com/YunoHost/pepettes/ - * YunoHost website: https://yunohost.org/ - ---- +* Official admin documentation: https://github.com/YunoHost/pepettes/blob/main/README.md +* Upstream app code repository: https://github.com/YunoHost/pepettes/ +* YunoHost documentation for this app: https://yunohost.org/app_pepettes +* Report a bug: https://github.com/YunoHost-Apps/pepettes_ynh/issues ## Developer info @@ -68,3 +50,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/pepettes_ynh/tree/tes or sudo yunohost app upgrade pepettes -u https://github.com/YunoHost-Apps/pepettes_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..50a5f27 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,50 @@ +# Pepettes pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/pepettes.svg)](https://dash.yunohost.org/appci/app/pepettes) ![](https://ci-apps.yunohost.org/ci/badges/pepettes.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/pepettes.maintain.svg) +[![Installer Pepettes avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=pepettes) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Pepettes 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 simple formulaire de don avec stripe + +**Version incluse :** 1.0.1~ynh1 + +**Démo :** https://donate.yunohost.org + +## Avertissements / informations importantes + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * requiring a full dedicated domain ? + * architectures not supported ? + * not-working single-sign on or LDAP integration ? + * the app requires an important amount of RAM / disk / .. to install or to work properly + * etc... + +* Other infos that people should be aware of, such as: + * How to configure this app: During the installation, or in `settings.py` after installation. + +## Documentations et ressources + +* Documentation officielle de l'admin : https://github.com/YunoHost/pepettes/blob/main/README.md +* Dépôt de code officiel de l'app : https://github.com/YunoHost/pepettes/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_pepettes +* Signaler un bug : https://github.com/YunoHost-Apps/pepettes_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/pepettes_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/pepettes_ynh/tree/testing --debug +ou +sudo yunohost app upgrade pepettes -u https://github.com/YunoHost-Apps/pepettes_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file