diff --git a/README.md b/README.md index 9828417..dafb6db 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,15 @@ -# HedgeDoc for YunoHost (formely CodiMD) +# CodiMD for YunoHost [![Integration level](https://dash.yunohost.org/integration/codimd.svg)](https://dash.yunohost.org/appci/app/codimd) ![](https://ci-apps.yunohost.org/ci/badges/codimd.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/codimd.maintain.svg) -[![Install HedgeDoc with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd) +[![Install CodiMD with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install HedgeDoc quickly and simply on a YunoHost server. +> *This package allows you to install CodiMD 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 -HedgeDoc is a real-time collaborative word processing web service. It uses Markdown language. - -*Note: This package install HedgeDoc, which was formely called CodiMD, and not what's now called CodiMD (the open source part of HackMD). See https://hedgedoc.org/history/* +CodiMD is a real-time collaborative word processing web service. It uses Markdown language. **Shipped version:** 1.6.0 @@ -25,7 +23,7 @@ HedgeDoc is a real-time collaborative word processing web service. It uses Markd ## Configuration -You can configure HedgeDoc by editing this file `/var/www/codimd/config.json` using the [documentation](https://github.com/codimd/server/blob/master/docs/configuration.md) +You can configure CodiMD by editing this file `/var/www/codimd/config.json` using the [documentation](https://github.com/codimd/server/blob/master/docs/configuration.md) ## Documentation diff --git a/README_fr.md b/README_fr.md index 1675530..ab17d22 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,17 +1,15 @@ -# HedgeDoc pour YunoHost (anciennement CodiMD) +# CodiMD pour YunoHost [![Niveau d'intégration](https://dash.yunohost.org/integration/codimd.svg)](https://dash.yunohost.org/appci/app/codimd) ![](https://ci-apps.yunohost.org/ci/badges/codimd.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/codimd.maintain.svg) -[![Installer HedgeDoc avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd) +[![Installer CodiMD avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=codimd) *[Read this readme in english.](./README.md)* -> *Ce package vous permet d'installer HedgeDoc rapidement et simplement sur un serveur YunoHost. +> *Ce package vous permet d'installer CodiMD 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.* ## Vue d'ensemble -HedgeDoc est un service web de traitement de texte collaboratif en temps réel. Il utilise le langage Markdown. - -*Note: Ce packet installe HedgeDoc, anciennement nommé CodiMD, et non ce qui s'appelle maintenant CodiMD (la partie open source d'HackMD). Cf. https://hedgedoc.org/history/* +CodiMD est un service web de traitement de texte collaboratif en temps réel. Il utilise le langage Markdown. **Version incluse :** 1.6.0 @@ -25,7 +23,7 @@ HedgeDoc est un service web de traitement de texte collaboratif en temps réel. ## Configuration -Vous pouvez configurer HedgeDoc en modifiant le fichier `/var/www/codimd/config.json` et en vous aidant de la [documentation](https://github.com/codimd/server/blob/master/docs/configuration.md) +Vous pouvez configurer CodiMD en modifiant le fichier `/var/www/codimd/config.json` et en vous aidant de la [documentation](https://github.com/codimd/server/blob/master/docs/configuration.md) ## Documentation @@ -62,3 +60,9 @@ sudo yunohost app install https://github.com/YunoHost-Apps/codimd_ynh/tree/testi ou sudo yunohost app upgrade codimd -u https://github.com/YunoHost-Apps/codimd_ynh/tree/testing --debug ``` +it. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/codimd_ynh/tree/testing --debug +ou +sudo yunohost app upgrade codimd -u https://github.com/YunoHost-Apps/codimd_ynh/tree/testing --debug +```