diff --git a/README.md b/README.md index 0705570..dea1509 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,8 @@ + + # Encryptic for YunoHost [![Integration level](https://dash.yunohost.org/integration/encryptic.svg)](https://dash.yunohost.org/appci/app/encryptic) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.maintain.svg) @@ -5,60 +10,40 @@ *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install Encryptic 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.* +> *This package allows you to install Encryptic 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 + Encryptic (fork of Laverna) is an anonymous system, encrypted and without registration required, it is accessible via a web browser (without software installation). The data is private because it is stored by default on your machine (InnoDB and localstorage), it is a setting in the settings that will allow you to synchronize it via the cloud on your various devices. -**Shipped version:** 0.1.0 +### Features + +- Markdown editor based on Pagedown +- Synchronization with cloud storage via Dropbox or RemoteStorage +- Multiple editing modes: normal, preview, and distraction free +- Offline access to your notes +- WYSIWYG control buttons +- Syntax highlighting, MathJax support +- Robust keyboard shortcuts + + +**Shipped version:** 0.1.0~ynh3 + +**Demo:** https://app.encryptic.org/ ## Screenshots -![](sources/encryptic.png) +![](./doc/screenshots/encryptic.png) -## Demo +## Documentation and resources -* [Official demo](https://app.encryptic.org/) - -## Configuration - -* How to configure this app: From an admin panel. - -## Documentation - - * Official documentation: https://github.com/encryptic-team/encryptic/wiki - * YunoHost documentation: If specific documentation is needed, feel free to contribute. - -## YunoHost specific features - -#### Multi-user support - - * Are LDAP and HTTP auth supported? **No** - * Can the app be used by multiple users? **Yes** - -#### Supported architectures - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/encryptic.svg)](https://ci-apps.yunohost.org/ci/apps/encryptic/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/encryptic.svg)](https://ci-apps-arm.yunohost.org/ci/apps/encryptic/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -## Links - - * Report a bug: https://github.com/YunoHost-Apps/encryptic_ynh/issues - * App website: https://encryptic.org/ - * Upstream app repository: https://github.com/encryptic-team/encryptic - * YunoHost website: https://yunohost.org/ - ---- +* Official app website: https://www.encryptic.org/ +* Official admin documentation: https://github.com/encryptic-team/encryptic/wiki +* Upstream app code repository: https://github.com/encryptic-team/encryptic +* YunoHost documentation for this app: https://yunohost.org/app_encryptic +* Report a bug: https://github.com/YunoHost-Apps/encryptic_ynh/issues ## Developer info @@ -70,3 +55,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/encryptic_ynh/tree/te or sudo yunohost app upgrade encryptic -u https://github.com/YunoHost-Apps/encryptic_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 index 5030368..b603361 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,64 +1,45 @@ # Encryptic pour YunoHost -[![Integration level](https://dash.yunohost.org/integration/encryptic.svg)](https://dash.yunohost.org/appci/app/encryptic) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/encryptic.svg)](https://dash.yunohost.org/appci/app/encryptic) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/encryptic.maintain.svg) [![Installer Encryptic avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=encryptic) -*[Read this readme in english.](./README.md)* +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* -> *Ce package vous permet d'installer Encryptic rapidement et simplement sur un serveur YunoHost. -Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/install) pour apprendre comment l'installer.* +> *Ce package vous permet d'installer Encryptic 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 -Encryptic est un système anonyme, crypté et sans inscription requise, il est accessible via un navigateur web (sans installation de logiciel). -Les données sont privées, car stockées par défaut sur votre machine (InnoDB et localstorage), c’est un réglage dans les paramètres qui vous permettra de les synchroniser via le cloud sur vos différents périphériques. -**Version incluse :** 0.1.0 +Encryptic (fork of Laverna) is an anonymous system, encrypted and without registration required, it is accessible via a web browser (without software installation). +The data is private because it is stored by default on your machine (InnoDB and localstorage), it is a setting in the settings that will allow you to synchronize it via the cloud on your various devices. + +### Features + +- Markdown editor based on Pagedown +- Synchronization with cloud storage via Dropbox or RemoteStorage +- Multiple editing modes: normal, preview, and distraction free +- Offline access to your notes +- WYSIWYG control buttons +- Syntax highlighting, MathJax support +- Robust keyboard shortcuts + + +**Version incluse :** 0.1.0~ynh3 + +**Démo :** https://app.encryptic.org/ ## Captures d'écran -![](sources/encryptic.png) +![](./doc/screenshots/encryptic.png) -## Démo +## Documentations et ressources -* [Démo officielle](https://app.encryptic.org/) - -## Configuration - -Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH ou tout autre moyen. - -## Documentation - - * Documentation officielle : https://github.com/encryptic-team/encryptic/wiki - * Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer. - -## Caractéristiques spécifiques YunoHost - -#### Support multi-utilisateur - -* L'authentification LDAP et HTTP est-elle prise en charge ? **Non** -* L'application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** - -#### Architectures supportées - -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/encryptic.svg)](https://ci-apps.yunohost.org/ci/apps/encryptic/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/encryptic.svg)](https://ci-apps-arm.yunohost.org/ci/apps/encryptic/) - -## Limitations - -* Limitations connues. - -## Informations additionnelles - -* Autres informations que vous souhaitez ajouter sur cette application. - -## Liens - - * Signaler un bug : https://github.com/YunoHost-Apps/encryptic_ynh/issues - * Site de l'application : https://encryptic.org/ - * Dépôt de l'application principale : https://github.com/encryptic-team/encryptic - * Site web YunoHost : https://yunohost.org/ - ---- +* Site officiel de l'app : https://www.encryptic.org/ +* Documentation officielle de l'admin : https://github.com/encryptic-team/encryptic/wiki +* Dépôt de code officiel de l'app : https://github.com/encryptic-team/encryptic +* Documentation YunoHost pour cette app : https://yunohost.org/app_encryptic +* Signaler un bug : https://github.com/YunoHost-Apps/encryptic_ynh/issues ## Informations pour les développeurs @@ -70,3 +51,5 @@ sudo yunohost app install https://github.com/YunoHost-Apps/encryptic_ynh/tree/te ou sudo yunohost app upgrade encryptic -u https://github.com/YunoHost-Apps/encryptic_ynh/tree/testing --debug ``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file