diff --git a/README.md b/README.md index 5b459ad..f4ce8f3 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,42 @@ + + # OpenNote for YunoHost [![Integration level](https://dash.yunohost.org/integration/opennote.svg)](https://dash.yunohost.org/appci/app/opennote) ![](https://ci-apps.yunohost.org/ci/badges/opennote.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/opennote.maintain.svg) -[![Install opennote with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=opennote) +[![Install OpenNote with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=opennote) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install OpenNote 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 -OpenNote is a progressive web application(PWA)/HTML5 offline app that was built to be a open source(MIT License), web based text editor/note taking software. It is designed to be self hosted and gives you ownership of your data -**Shipped version:** 18.03.00 +Alternative to Microsoft OneNote and EverNote. -## Demo +**Shipped version:** 18.03.00~ynh1 -* [Official demo](https://foxusa.github.io/OpenNote/OpenNote/#/folder) +**Demo:** https://foxusa.github.io/OpenNote/OpenNote/#/folder -#### Supported architectures +## Documentation and resources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/opennote%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/opennote/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/opennote%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/opennote/) +* Official app website: https://foxusa.github.io/OpenNote/OpenNote/ +* Upstream app code repository: https://github.com/FoxUSA/OpenNote/ +* YunoHost documentation for this app: https://yunohost.org/app_opennote +* Report a bug: https://github.com/YunoHost-Apps/opennote_ynh/issues -## Links +## Developer info - * Report a bug: https://github.com/YunoHost-Apps/opennote_ynh/issues - * Upstream app repository: https://github.com/FoxUSA/OpenNote/ - * YunoHost website: https://yunohost.org/ +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/opennote_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/opennote_ynh/tree/testing --debug +or +sudo yunohost app upgrade opennote -u https://github.com/YunoHost-Apps/opennote_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..2077f70 --- /dev/null +++ b/README_fr.md @@ -0,0 +1,38 @@ +# OpenNote pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/opennote.svg)](https://dash.yunohost.org/appci/app/opennote) ![](https://ci-apps.yunohost.org/ci/badges/opennote.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/opennote.maintain.svg) +[![Installer OpenNote avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=opennote) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer OpenNote 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 + +Alternative web à Microsoft OneNote and EverNote. + +**Version incluse :** 18.03.00~ynh1 + +**Démo :** https://foxusa.github.io/OpenNote/OpenNote/#/folder + +## Documentations et ressources + +* Site officiel de l'app : https://foxusa.github.io/OpenNote/OpenNote/ +* Dépôt de code officiel de l'app : https://github.com/FoxUSA/OpenNote/ +* Documentation YunoHost pour cette app : https://yunohost.org/app_opennote +* Signaler un bug : https://github.com/YunoHost-Apps/opennote_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/opennote_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/opennote_ynh/tree/testing --debug +ou +sudo yunohost app upgrade opennote -u https://github.com/YunoHost-Apps/opennote_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file