From 4b40df068df900ca23cc895069d0363ee0cf19a2 Mon Sep 17 00:00:00 2001 From: Stylix58 <63605602+Stylix58@users.noreply.github.com> Date: Thu, 1 Apr 2021 13:19:44 +0200 Subject: [PATCH] Update README.md --- README.md | 63 +++++++++++++++---------------------------------------- 1 file changed, 17 insertions(+), 46 deletions(-) diff --git a/README.md b/README.md index fb6c89c..52b8b9a 100644 --- a/README.md +++ b/README.md @@ -1,72 +1,43 @@ -# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) -- Copy this app before working on it. -- Edit the `conf/nginx.conf` file to match app prerequisites. -- Edit the `manifest.json` with app specific info. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts. - - Using the [script helpers documentation.](https://yunohost.org/#/packaging_apps_helpers) -- Add a `LICENSE` file for the package. -- Edit `README.md` and `README_fr.md`. +# ChuWiki for YunoHost -# Example app for YunoHost - -[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.maintain.svg) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) +[![Integration level](https://dash.yunohost.org/integration/chuwiki.svg)](https://dash.yunohost.org/appci/app/chuwiki) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/chuwiki.maintain.svg) +[![Install chuwiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=chuwiki) *[Lire ce readme en français.](./README_fr.md)* -> *This package allows you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server. +> *This package allows you to install ChuWiki 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 -Quick description of this app. +A simple, fast and flexible wiki. -**Shipped version:** 1.0 - -## Screenshots - -![](Link to a screenshot of this app.) - -## Demo - -* [Official demo](Link to a demo site for this app.) +**Shipped version:** 2.0 ## Configuration -How to configure this app: From an admin panel, a plain file with SSH, or any other way. +How to configure this app: From `configuration.ini` file. ## Documentation - * Official documentation: Link to the official documentation of this app + * Official documentation: http://chuwiki.genezys.net/ * YunoHost documentation: If specific documentation is needed, feel free to contribute. ## YunoHost specific features #### Multi-user support -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? +Are LDAP and HTTP auth supported? Yes. +Can the app be used by multiple users? Yes, but it is not specific to YunoHost but to the app. #### Supported architectures -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other info you would like to add about this app. - -**More info on the documentation page:** -https://yunohost.org/packaging_apps +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/chuwiki/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/chuwiki%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/chuwiki/) ## Links - * Report a bug: https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues - * App website: Link to the official website of this app. - * Upstream app repository: Link to the official repository of the upstream app. + * Report a bug: https://github.com/YunoHost-Apps/chuwiki_ynh/issues + * App website: http://chuwiki.genezys.net/ * YunoHost website: https://yunohost.org/ --- @@ -74,11 +45,11 @@ https://yunohost.org/packaging_apps ## Developer info **Only if you want to use a testing branch for coding, instead of merging directly into master.** -Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing). +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing). To try the testing branch, please proceed like that. ``` -sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app install https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing --debug or -sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug +sudo yunohost app upgrade chuwiki -u https://github.com/YunoHost-Apps/chuwiki_ynh/tree/testing --debug ```