diff --git a/README.md b/README.md index 65ca3e3..63ac526 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,40 @@ -# Standard Notes Server pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver) ![](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg) -[![Installer snserver avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=snserver) -*[Read this readme in english.](./README.md)* +--- + + + +# Standard Notes Server for YunoHost + +[![Integration level](https://dash.yunohost.org/integration/snserver.svg)](https://dash.yunohost.org/appci/app/snserver) ![](https://ci-apps.yunohost.org/ci/badges/snserver.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/snserver.maintain.svg) +[![Install snserver with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=snserver) + *[Lire ce readme en français.](./README_fr.md)* > *This package allows you to install snserver 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.* -## Vue d'ensemble +## Overview +The Standard Notes syncing server. An end-to-end encrypted note-taking app. +**Shipped version:** 3.22.8~ynh2 -**Version incluse:** 3.22.8~ynh2 - -**Démo:** https://standardnotes.org/demo +**Demo:** https://standardnotes.org/demo -## Avertissements / informations importantes +## Disclaimers / important information * Any known limitations, constrains or stuff not working, such as (but not limited to): * No single-sign on or LDAP integration * The app requires up 600MB of RAM to install * The app requires at least 110MB of RAM to work properly. And will increase with use. + * The app requires around 300MB of disk. * Other infos that people should be aware of, such as: * The config-file is stored under "/opt/yunohost/$app/live/.env" @@ -34,24 +43,24 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in -## Documentations et ressources +## Documentation and resources -* Site official de l'app : https://standardnotes.org/ -* Documentation officielle utilisateur: https://docs.standardnotes.org/ -* Documentation officielle de l'admin: https://docs.standardnotes.org/ -* Dépôt de code officiel de l'app: https://github.com/standardnotes/syncing-server -* Documentation YunoHost pour cette app: https://yunohost.org/app_snserver -* Signaler un bug: https://github.com/YunoHost-Apps/snserver_ynh/issues +* Official app website: https://standardnotes.org/ +* Official user documentation: https://docs.standardnotes.org/ +* Official admin documentation: https://docs.standardnotes.org/ +* Upstream app code repository: https://github.com/standardnotes/syncing-server +* YunoHost documentation for this app: https://yunohost.org/app_snserver +* Report a bug: https://github.com/YunoHost-Apps/snserver_ynh/issues -## Informations pour les développeurs +## Developer info -Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/snserver_ynh/tree/testing). -Pour essayer la branche testing, procédez comme suit. +To try the testing branch, please proceed like that. ``` sudo yunohost app install https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug or sudo yunohost app upgrade snserver -u https://github.com/YunoHost-Apps/snserver_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications:** https://yunohost.org/packaging_apps \ No newline at end of file +**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 index 65ca3e3..434f302 100644 --- a/README_fr.md +++ b/README_fr.md @@ -26,6 +26,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in * No single-sign on or LDAP integration * The app requires up 600MB of RAM to install * The app requires at least 110MB of RAM to work properly. And will increase with use. + * The app requires around 300MB of disk. * Other infos that people should be aware of, such as: * The config-file is stored under "/opt/yunohost/$app/live/.env"