diff --git a/README.md b/README.md index 22b475e..710e3cc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # HedgeDoc for YunoHost -[![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![Working status](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) [![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) *[Lire ce readme en français.](./README_fr.md)* @@ -15,15 +15,26 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -Collaborative editor to work on notes written in Markdown +HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor. -**Shipped version:** 1.9.3~ynh1 +You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go. + +### Features + +- Real-time collaboration +- Graphs & diagrams +- Revisions +- Presentation mode +- Easy to use permission system +- Low system requirements + +**Shipped version:** 1.9.4~ynh1 **Demo:** https://demo.hedgedoc.org/ ## Screenshots -![](./doc/screenshots/screenshot.png) +![Screenshot of HedgeDoc](./doc/screenshots/screenshot.png) ## Disclaimers / important information @@ -34,21 +45,22 @@ When you finished editing the configuration, for your changes to take effect, yo ## Documentation and resources -* Official app website: https://hedgedoc.org -* Official admin documentation: https://docs.hedgedoc.org/ -* Upstream app code repository: https://github.com/hedgedoc/hedgedoc -* YunoHost documentation for this app: https://yunohost.org/app_hedgedoc -* Report a bug: https://github.com/YunoHost-Apps/hedgedoc_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug or sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 8b8c5a4..1f9c333 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,25 +1,40 @@ + + # HedgeDoc pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/hedgedoc.svg)](https://dash.yunohost.org/appci/app/hedgedoc) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/hedgedoc.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/hedgedoc.maintain.svg) [![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=hedgedoc) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer HedgeDoc 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 -Éditeur collaboratif pour travailler sur des notes en Markdown +HedgeDoc (formerly known as CodiMD) is an open-source, web-based, self-hosted, collaborative markdown editor. -**Version incluse :** 1.9.3~ynh1 +You can use it to easily collaborate on notes, graphs and even presentations in real-time. All you need to do is to share your note-link to your co-workers and they’re ready to go. + +### Features + +- Real-time collaboration +- Graphs & diagrams +- Revisions +- Presentation mode +- Easy to use permission system +- Low system requirements + +**Version incluse :** 1.9.4~ynh1 **Démo :** https://demo.hedgedoc.org/ ## Captures d'écran -![](./doc/screenshots/screenshot.png) +![Capture d'écran de HedgeDoc](./doc/screenshots/screenshot.png) ## Avertissements / informations importantes @@ -30,21 +45,22 @@ Lorsque vous avez terminé de modifier la configuration, pour que vos modificati ## Documentations et ressources -* Site officiel de l'app : https://hedgedoc.org -* Documentation officielle de l'admin : https://docs.hedgedoc.org/ -* Dépôt de code officiel de l'app : https://github.com/hedgedoc/hedgedoc -* Documentation YunoHost pour cette app : https://yunohost.org/app_hedgedoc -* Signaler un bug : https://github.com/YunoHost-Apps/hedgedoc_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug ou sudo yunohost app upgrade hedgedoc -u https://github.com/YunoHost-Apps/hedgedoc_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :**