From 718ec95c746d8e43ed6e21d7ae406b354370fea4 Mon Sep 17 00:00:00 2001 From: Yunohost-Bot <> Date: Fri, 20 Aug 2021 17:36:41 +0000 Subject: [PATCH] Auto-update README --- README.md | 78 +++++++++++++++++++++------------------------------- README_fr.md | 55 ++++++++++++++++++++++++++++++++++++ 2 files changed, 87 insertions(+), 46 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 4c69eae..619538f 100644 --- a/README.md +++ b/README.md @@ -1,67 +1,51 @@ -# Invoice Ninja 4 for YunoHost + -:warning: You are invited to look at [InvoiceNinja 5](https://github.com/YunoHost-Apps/invoiceninja5_ynh) :warning: +# InvoiceNinja for YunoHost [![Integration level](https://dash.yunohost.org/integration/invoiceninja.svg)](https://dash.yunohost.org/appci/app/invoiceninja) ![](https://ci-apps.yunohost.org/ci/badges/invoiceninja.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/invoiceninja.maintain.svg) -[![Install Invoice Ninja with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=invoiceninja) +[![Install InvoiceNinja with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=invoiceninja) -> *This package allows you to install Invoice Ninja quickly and simply on a YunoHost server. +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install InvoiceNinja 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 -Invoice Ninja is the #1 open-source platform to create & email invoices, track payments and expenses, and time billable tasks & projects for clients. -**Shipped version:** v4.5.43 +Create and email invoices, track payments and expenses, and time tasks + +**Shipped version:** 4.5.43~ynh1 + +**Demo:** https://app.invoiceninja.com/dashboard ## Screenshots -![](https://www.invoiceninja.com/wp-content/uploads/2015/11/Create-Invoices-in-Seconds.png) +![](./doc/screenshots/screenshot.png) -## Demo +## Disclaimers / important information -* [Official demo](https://app.invoiceninja.com/dashboard) +:warning: You are invited to look at [InvoiceNinja 5](https://github.com/YunoHost-Apps/invoiceninja5_ynh) :warning: -## Configuration +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * There is no official LDAP support + * The first user gets created after installing Invoice Ninja + * Other users can be created from inside the application -Configuration happens in the application itself. +* Other infos that people should be aware of, such as: + * Configuration happens in the application itself. -## Documentation +## Documentation and resources - * Official documentation: https://docs.invoiceninja.com/index.html +* Official app website: https://invoiceninja.org +* Official admin documentation: https://docs.invoiceninja.com/index.html +* Upstream app code repository: https://github.com/invoiceninja/invoiceninja +* YunoHost documentation for this app: https://yunohost.org/app_invoiceninja +* Report a bug: https://github.com/YunoHost-Apps/invoiceninja_ynh/issues -## YunoHost specific features - -#### Multi-user support - -* There is no official LDAP support -* The first user gets created after installing Invoice Ninja -* Other users can be created from inside the application - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/invoiceninja%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/invoiceninja/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/invoiceninja%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/invoiceninja/) - -## Limitations - -* Any known limitations. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/invoiceninja_ynh/issues - * App website: https://www.invoiceninja.org/ - * Upstream app repository: https://github.com/invoiceninja/invoiceninja - * YunoHost website: https://yunohost.org/ - -## TODOs - -* If possible, create initial user -* Test upgrade - ---- - -Developer info ----------------- +## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/invoiceninja_ynh/tree/testing). @@ -71,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/invoiceninja_ynh/tree or sudo yunohost app upgrade invoiceninja -u https://github.com/YunoHost-Apps/invoiceninja_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..358efa9 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,55 @@ +# InvoiceNinja pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/invoiceninja.svg)](https://dash.yunohost.org/appci/app/invoiceninja) ![](https://ci-apps.yunohost.org/ci/badges/invoiceninja.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/invoiceninja.maintain.svg) +[![Installer InvoiceNinja avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=invoiceninja) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer InvoiceNinja 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 :** 4.5.43~ynh1 + +**Démo :** https://app.invoiceninja.com/dashboard + +## Captures d'écran + +![](./doc/screenshots/screenshot.png) + +## Avertissements / informations importantes + +:warning: You are invited to look at [InvoiceNinja 5](https://github.com/YunoHost-Apps/invoiceninja5_ynh) :warning: + +* Any known limitations, constrains or stuff not working, such as (but not limited to): + * There is no official LDAP support + * The first user gets created after installing Invoice Ninja + * Other users can be created from inside the application + +* Other infos that people should be aware of, such as: + * Configuration happens in the application itself. + +## Documentations et ressources + +* Site officiel de l'app : https://invoiceninja.org +* Documentation officielle de l'admin : https://docs.invoiceninja.com/index.html +* Dépôt de code officiel de l'app : https://github.com/invoiceninja/invoiceninja +* Documentation YunoHost pour cette app : https://yunohost.org/app_invoiceninja +* Signaler un bug : https://github.com/YunoHost-Apps/invoiceninja_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/invoiceninja_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/invoiceninja_ynh/tree/testing --debug +ou +sudo yunohost app upgrade invoiceninja -u https://github.com/YunoHost-Apps/invoiceninja_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file