diff --git a/README.md b/README.md index f1b3175..5eb5823 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,71 @@ # MineWeb for YunoHost [![Integration level](https://dash.yunohost.org/integration/mineweb.svg)](https://dash.yunohost.org/appci/app/mineweb) ![](https://ci-apps.yunohost.org/ci/badges/mineweb.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mineweb.maintain.svg) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mineweb) +[![Install MineWeb with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=mineweb) -MineWeb CMS +*[Lire ce readme en français.](./README_fr.md)* -- [Yunohost project](https://yunohost.org) -- [MineWeb website](https://mineweb.org/) +> *This package allows you to install MineWeb 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.* -![](https://pbs.twimg.com/profile_images/677988479356268544/vYHw5hNj_400x400.png) +## Overview +Quick description of this app. -### Installing guide +**Shipped version:** 1.0 - App can be installed by YunoHost **admin web-interface** or by **running following command**: +## Screenshots - $ sudo yunohost app install https://github.com/YunoHost-Apps/mineweb_ynh +![](Link to a screenshot of this app.) - -### Upgrade this package: +## Demo - $ sudo yunohost app upgrade mineweb -u https://github.com/YunoHost-Apps/mineweb_ynh +* [Official demo](Link to a demo site for this app.) +## Configuration + +How to configure this app: From an admin panel, a plain file with SSH, or any other way. + +## Documentation + + * Official documentation: Link to the official documentation of this app + * 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? + +#### Supported architectures + +* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mineweb%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mineweb/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/minewebP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mineweb/) + +## Limitations + +* Any known limitations. + +## Additional information + +* Other info you would like to add about this app. + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/mineweb_ynh/issues + * App website: https://mineweb.org/ + * Upstream app repository: https://github.com/MineWeb/MineWebCMS/ + * YunoHost website: https://yunohost.org/ + +--- + +## Developer info + +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/mineweb_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/mineweb_ynh/tree/testing --debug +or +sudo yunohost app upgrade mineweb -u https://github.com/YunoHost-Apps/mineweb_ynh/tree/testing --debug +``` diff --git a/manifest.json b/manifest.json index a840e06..874c29c 100644 --- a/manifest.json +++ b/manifest.json @@ -3,8 +3,8 @@ "id": "mineweb", "packaging_format": 1, "description": { - "en": "MineWeb package for YunoHost.", - "fr": "MineWeb pour YunoHost." + "en": "", + "fr": "" }, "version": "1.10.3~ynh1", "url": "https://mineweb.org/", @@ -46,7 +46,7 @@ "name": "is_public", "type": "boolean", "ask": { - "en": "Is it a public site ?", + "en": "Is it a public site?", "fr": "Est-ce un site public ?" }, "default": true