From df9f2c17c4cfab0f6ec30b082e534f1b77c82282 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Allan=20Nordh=C3=B8y?= Date: Thu, 23 Jan 2020 23:33:06 +0100 Subject: [PATCH] wikijs_ynh readme reworked --- README.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 1ac6b49..57b84f7 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,19 @@ [![Integration level](https://dash.yunohost.org/integration/wikijs.svg)](https://dash.yunohost.org/appci/app/wikijs) [![Install wikijs with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wikijs) -> *This package allow you to install wikijs quickly and simply on a YunoHost server. -If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.* +> *This package allows you to install wikijs easily and quickly on a YunoHost server. +If you don't have YunoHost, please look at [the guide](https://yunohost.org/#/install) to learn how to install it.* ## Overview -An open source, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost. +A copylefted libre software, modern and powerful wiki app built on Node.js, Git and Markdown for YunoHost. **Shipped version:** 2.0.12 -## Important points to read before installing +## Important points before installing -**Wiki.js is still under development, all features not already implemented.** +**Wiki.js is still under development, not all features are implemented yet.** -**Wiki.js** require a dedicated **root domain**, eg. wikijs.domain.tld +**Wiki.js** requires a dedicated **root domain**, e.g. wikijs.domain.tld ## Screenshots @@ -33,15 +33,15 @@ An open source, modern and powerful wiki app built on Node.js, Git and Markdown ## YunoHost specific features -#### Multi-users support +#### Multi-user support -LDAP is implemented, root will receive a mail at the end of the installation or the upgrade with the informations to configure LDAP. -No HTTP auth for now but planned to be supported. -The app can be used by multiple users +LDAP is implemented, root will receive an e-mail at the end of the installation or the upgrade with the info on how to configure LDAP. +No HTTP auth for now, but planned for the future. +The app can be used by multiple users. #### Supported architectures -* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/) +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/wikijs/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wikijs%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wikijs/) ## Limitations @@ -60,7 +60,7 @@ The app can be used by multiple users Developers info ---------------- -Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/wikijs_ynh/tree/testing). To try the testing branch, please proceed like that. ```