From 256e5ec780af284a954e936f41a57dfd55032a19 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 5 Feb 2019 23:00:28 +0100 Subject: [PATCH] Apply example_ynh on README.md --- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 49 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ee4286f..99f926e 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,17 @@ # Wekan for Yunohost -Wekan is an open-source kanban board (task manager and organizer) - [![Integration level](https://dash.yunohost.org/integration/wekan.svg)](https://dash.yunohost.org/appci/app/wekan) -[![Install Wordpress with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wekan) +[![Install Wekan with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wekan) + +> *This package allow you to install wekan 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 +Wekan is an open-source kanban board (task manager and organizer) **Shipped version:** 2.09 -## Screenshot +## Screenshots ![](screenshot.jpg) @@ -30,3 +34,44 @@ Wekan is an open-source kanban board (task manager and organizer) **Private/Public mode:** In private mode, only authorized YunoHost members can access to the wekan. **SSO/LDAP:** SSO and LDAP are not configured. + +## Configuration + +First registered user will be admin, and next ones normal users. If you want other admins too, you can change their permission to admin at Wekan Admin Panel. + +## Documentation + + * Official documentation: https://github.com/wekan/wekan/wiki + +## YunoHost specific features + +#### Supported architectures + +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/wekan%20%28Community%29.svg)](https://ci-apps.yunohost.org/ci/apps/wekan/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/wekan%20%28Community%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/wekan/) +* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/wekan%20%28Community%29.svg)](https://ci-stretch.nohost.me/ci/apps/wekan/) + +## Limitations + +* Any known limitations. + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/wekan_ynh/issues + * App website: Link to the official website of this app + * YunoHost website: https://yunohost.org/ + +--- + +Developers info +---------------- + +**Only if you want to use a testing branch for coding, instead of merging directly into master.** +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/wekan_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/wekan_ynh/tree/testing --debug +or +sudo yunohost app upgrade wekan -u https://github.com/YunoHost-Apps/wekan_ynh/tree/testing --debug +```