From 1a5a0e5234574c347bb75d182557f9984b8ede50 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Sun, 23 Jan 2022 22:07:20 +0000 Subject: [PATCH] Auto-update README --- README.md | 66 +++++++++++++++++++++------------------------------- README_fr.md | 47 +++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+), 40 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 72516d4..c15391e 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,43 @@ -# Monica app for YunoHost + + +# Monica for YunoHost [![Integration level](https://dash.yunohost.org/integration/monica.svg)](https://dash.yunohost.org/appci/app/monica) ![](https://ci-apps.yunohost.org/ci/badges/monica.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/monica.maintain.svg) -[![Install Monica with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=monica) +[![Install Monica with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=monica) -> *This package allows you to install Monica quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install Monica 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 + Monica is an open-source web application to organize the interactions with your loved ones. I call it a PRM, or Personal Relationship Management. Think of it as a [CRM](https://en.wikipedia.org/wiki/Customer_relationship_management) (a popular tool used by sales teams in the corporate world) for your friends or family. -**Shipped version:** 2.17.0 + +**Shipped version:** 2.17.0~ynh3 + + ## Screenshots -![](https://www.monicahq.com/img/contacts.png) +![](./doc/screenshots/screenshot1.png) -## Configuration +## Disclaimers / important information -Change the settings of the app by changing the values in .env +* **First User Registration:** Visit the app **domain** after the installation is complete to register as **first user**. After the first user is registered the registration will be **locked**. You can open the register for all by changing the value **APP_DISABLE_SIGNUP** to **false** in **.env**. There is **no admin interface** in the Monica app currently. -## YunoHost specific features +## Documentation and resources -#### Multi-user support +* Official app website: https://monicahq.com +* Upstream app code repository: https://github.com/monicahq/monica +* YunoHost documentation for this app: https://yunohost.org/app_monica +* Report a bug: https://github.com/YunoHost-Apps/monica_ynh/issues -**First User Registration:** Visit the app **domain** after the installation is complete to register as **first user**. After the first user is registered the registration will be **locked**. You can open the register for all by changing the value **APP_DISABLE_SIGNUP** to **false** in **.env**. There is **no admin interface** in the Monica app currently. - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/monica%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/monica/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/monica%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/monica/) - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/monica_ynh/issues - * App website: https://monicahq.com/ - * Upstream app repository: https://github.com/monicahq/monica - * YunoHost website: https://yunohost.org/ - -## Introduction - - -## What works? -* [X] Update and remove script -* [X] Upgrade script -* [X] Backup and restore script (**Need testing**) -* [X] Multi-instance (**Need testing**) -* [x] make root domain redirect to index.php -* [x] Chang URL (Need testing,backup before trying this) -* [ ] LDAP/SSO support -* [x] Make monica installable into subdirectory (eg. https://example.com/monica/) - ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/monica_ynh/tree/testing). @@ -63,3 +47,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/monica_ynh/tree/testi or sudo yunohost app upgrade monica -u https://github.com/YunoHost-Apps/monica_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..c18fd76 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,47 @@ +# Monica pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/monica.svg)](https://dash.yunohost.org/appci/app/monica) ![](https://ci-apps.yunohost.org/ci/badges/monica.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/monica.maintain.svg) +[![Installer Monica avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=monica) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer Monica 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 + +Monica is an open-source web application to organize the interactions with your loved ones. I call it a PRM, or Personal Relationship Management. Think of it as a [CRM](https://en.wikipedia.org/wiki/Customer_relationship_management) (a popular tool used by sales teams in the corporate world) for your friends or family. + + +**Version incluse :** 2.17.0~ynh3 + + + +## Captures d'écran + +![](./doc/screenshots/screenshot1.png) + +## Avertissements / informations importantes + +* **First User Registration:** Visit the app **domain** after the installation is complete to register as **first user**. After the first user is registered the registration will be **locked**. You can open the register for all by changing the value **APP_DISABLE_SIGNUP** to **false** in **.env**. There is **no admin interface** in the Monica app currently. + +## Documentations et ressources + +* Site officiel de l'app : https://monicahq.com +* Dépôt de code officiel de l'app : https://github.com/monicahq/monica +* Documentation YunoHost pour cette app : https://yunohost.org/app_monica +* Signaler un bug : https://github.com/YunoHost-Apps/monica_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/monica_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug +ou +sudo yunohost app upgrade monica -u https://github.com/YunoHost-Apps/monica_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file