From 78d817738c12ef22276a82a6245ddd79c77ca649 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Wed, 3 Jun 2020 09:43:47 +0200 Subject: [PATCH] Improve descriptions --- README.md | 10 +++++----- README_fr.md | 11 ++++++----- 2 files changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 268587c..3eb4ec6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to ## Overview -Collaborative editor to work on notes written in Markdown. +CodiMD is a real-time collaborative word processing web service. It uses Markdown language. **Shipped version:** 1.6.0 @@ -24,7 +24,7 @@ Collaborative editor to work on notes written in Markdown. ## Configuration -If you need to configure CodiMD, you can tweak `/var/www/codimd/config.json` file using this [documentation](https://github.com/codimd/server/blob/master/docs/configuration-config-file.md) +You can configure CodiMD by editing this file `/var/www/codimd/config.json` using this the [documentation](https://github.com/codimd/server/blob/master/docs/configuration-config-file.md) ## Documentation @@ -35,12 +35,12 @@ If you need to configure CodiMD, you can tweak `/var/www/codimd/config.json` fil #### Multi-users support -* Is LDAP supported? Yes -* Can the app be used by multiple users? Yes +* Is LDAP supported? **Yes** +* Can the app be used by multiple users? **Yes** #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/codimd%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/codimd/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/codimd%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/codimd/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/codimd%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/codimd/) ## Limitations diff --git a/README_fr.md b/README_fr.md index 5c61c1b..df60c3a 100644 --- a/README_fr.md +++ b/README_fr.md @@ -9,7 +9,8 @@ Si vous n’avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l’installer.* ## Vue d’ensemble -Éditeur collaboratif pour travailler sur des notes en Markdown. + +CodiMD est un service web de traitement de texte collaboratif en temps réel. Il utilise le langage Markdown. **Version incluse:** 1.6.0 @@ -23,7 +24,7 @@ Si vous n’avez pas YunoHost, consultez [le guide](https://yunohost.org/#/insta ## Configuration -Si vous voulez configurer CodiMD, vous pouvez modifier votre fichier `/var/www/codimd/config.json` en vous aidant de la [documentation](https://github.com/codimd/server/blob/master/docs/configuration-config-file.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-config-file.md) ## Documentation @@ -34,12 +35,12 @@ Si vous voulez configurer CodiMD, vous pouvez modifier votre fichier `/var/www/c #### Support multi-utilisateurs -* L’authentification LDAP est-elle prise en charge ? Oui -* L’application peut-elle être utilisée par plusieurs utilisateurs ? Oui +* L’authentification LDAP est-elle prise en charge ? **Oui** +* L’application peut-elle être utilisée par plusieurs utilisateurs ? **Oui** #### Architectures supportées -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/codimd%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/codimd/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/codimd%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/codimd/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/codimd%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/codimd/) ## Limitations