From 7520ddedf97899e3331185a52e78296be35de2fa Mon Sep 17 00:00:00 2001 From: Salamandar <6552989+Salamandar@users.noreply.github.com> Date: Wed, 10 Jun 2020 15:09:08 +0200 Subject: [PATCH] Rewrite Readme --- README.md | 44 +++++++++++++++++++++++++------------------- 1 file changed, 25 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 136a207..7344ab0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,17 @@ # MediaWiki for YunoHost -[![Integration level](https://dash.yunohost.org/integration/mediawiki.svg)](https://dash.yunohost.org/appci/app/mediawiki) ![](https://ci-apps.yunohost.org/ci/badges/mediawiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mediawiki.maintain.svg) +[ +![](https://dash.yunohost.org/integration/mediawiki.svg) +![](https://ci-apps.yunohost.org/ci/badges/mediawiki.status.svg) +![](https://ci-apps.yunohost.org/ci/badges/mediawiki.maintain.svg) +](https://dash.yunohost.org/appci/app/mediawiki) + [![Install WediaWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mediawiki) *[Lire ce readme en français.](./README_fr.md)* -> *This package allow you to install MediaWiki 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 allow you to install MediaWiki 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.* ## Overview @@ -22,7 +27,7 @@ MediaWiki is a free and open source software wiki package written in PHP, origin * [LDAPUserInfo](https://www.mediawiki.org/wiki/Extension:LDAPUserInfo): 1.33 Stable (**disabled and unused for now**) * [LDAPAuthorization](https://www.mediawiki.org/wiki/Extension:LDAPAuthorization): 1.33 Stable (**disabled and unused for now**) -Please note, there is no available 1.32.0 version of the LDAP* extensions but the installation portal assures that they work across various different version of MediaWiki. This is currently the case. We will be working towards a MediaWiki [1.33.0 upgrade shortly](https://github.com/YunoHost-Apps/mediawiki_ynh/issues/4). Some of the extensions are marked as "disabled and unused" because they are not immediately required but are part of the MediaWiki "LDAP Stack" which may be needed in future versions. +Some of the extensions are marked as "disabled and unused" because they are not immediately required but are part of the MediaWiki "LDAP Stack" which may be needed in future versions. ## Screenshots @@ -30,46 +35,47 @@ Please note, there is no available 1.32.0 version of the LDAP* extensions but th ## Demo -* [Official demo](https://www.mediawiki.org/wiki/Project:Sandbox) + * [Official demo](https://www.mediawiki.org/wiki/Project:Sandbox) ## Configuration How to configure this app: - * Through the admin panel: Log in then click on `Preferences` + * Through the admin panel: Log in then click on `Preferences` ## Documentation - * Official documentation: https://www.mediawiki.org/ - * YunoHost documentation: https://yunohost.org/#/app_mediawiki + * Official documentation: https://www.mediawiki.org + * YunoHost documentation: https://yunohost.org/#/app_mediawiki ## YunoHost specific features #### Multi-users support -* Is LDAP supported?: **yes** -* Is HTTP auth supported?: **no** -* Can the app be used by multiple users?: **yes** + * Is LDAP supported?: **yes** + * Is 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/mediawiki%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/) + * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mediawiki%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mediawiki/) + * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mediawiki%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mediawiki/) + * Buster x86-64b - [![Build Status](https://ci-buster.nohost.me/ci/logs/mediawiki%20%28Apps%29.svg)](https://ci-buster.nohost.me/ci/apps/mediawiki/) ## Limitations -* Any known limitations. + * Any known limitations. ## Additional information -* The [Discourse forum topic](https://forum.yunohost.org/t/community-app-mediawiki-free-software-wiki-package-wikipedia/8588) tracking release schedule and feedback. + * The [Discourse forum topic](https://forum.yunohost.org/t/community-app-mediawiki-free-software-wiki-package-wikipedia/8588) tracking release schedule and feedback. ## Links - * Report a bug: https://github.com/YunoHost-Apps/mediawiki_ynh/issues - * App website: https://www.mediawiki.org/ - * Upstream app repository: https://github.com/wikimedia/mediawiki - * YunoHost website: https://yunohost.org/ + * Report a bug: https://github.com/YunoHost-Apps/mediawiki_ynh/issues + * App website: https://www.mediawiki.org + * Upstream app repository: https://github.com/wikimedia/mediawiki + * YunoHost website: https://yunohost.org ---