diff --git a/README.md b/README.md index 9dae3d7..0c4016b 100644 --- a/README.md +++ b/README.md @@ -1,73 +1,39 @@ -# Usage of this package (REMOVE THIS SECTION BEFORE RELEASE) -- Copy this app before working on it. -- Edit `conf/nginx.conf` file to match application prerequisites. -- Edit `manifest.json` with application specific information. -- Edit the `install`, `upgrade`, `remove`, `backup`, and `restore` scripts. - - Using the [script helpers documentation.](https://helpers.yunohost.org/) -- Add a `LICENSE` file for the package. -- Edit `README.md` and README_fr.md. +# YunoMonitor -# Example app for YunoHost +[![Integration level](https://dash.yunohost.org/integration/yunomonitor.svg)](https://dash.yunohost.org/appci/app/yunomonitor) +[![Install yunomonitor with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=yunomonitor) -[![Integration level](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) -[![Install REPLACEBYYOURAPP with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP) -*[Lire ce readme en français.](./README_fr.md)* - -> *This package allow you to install REPLACEBYYOURAPP quickly and simply on a YunoHost server. +> *This package allow you to install yunomonitor 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 -Quick description of this app. +YunoMonitor is a simple tools to auto-configure monitoring on a remote YunoHost server. So you need one server to monitor and another to run monitoring task. + +YunoMonitor can send you email or SMS if you give him an URL API to do it (like the API from the operator "free mobile"). **Shipped version:** 1.0 -## Screenshots - -![](Link to an screenshot for this app) - -## Demo - -* [Official demo](Link to a demo site for this app) - ## Configuration -How to configure this app: by an admin panel, a plain file with SSH, or any other way. +To configure this app. ## Documentation - * Official documentation: Link to the official documentation of this app - * YunoHost documentation: If specific documentation is needed, feel free to contribute. + * Official documentation: https://github.com/zamentur/yunomonitor/blob/master/README.md ## YunoHost specific features -#### Multi-users support - -Are LDAP and HTTP auth supported? -Can the app be used by multiple users? - #### Supported architectures -* x86-64b - [![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/) -* Jessie x86-64b - [![Build Status](https://ci-stretch.nohost.me/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-stretch.nohost.me/ci/apps/REPLACEBYYOURAPP/) - -## Limitations - -* Any known limitations. - -## Additional information - -* Other information you would add about this application - -**More information on the documentation page:** -https://yunohost.org/packaging_apps +* x86-64b - [![Build Status](https://ci-apps.yunohost.org/ci/logs/yunomonitor%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/yunomonitor/) +* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/yunomonitor%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/yunomonitor/) ## 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/yunomonitor_ynh/issues + * App website: https://github.com/zamentur/yunomonitor + * Upstream app repository: https://github.com/zamentur/yunomonitor * YunoHost website: https://yunohost.org/ --- @@ -76,11 +42,11 @@ 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/REPLACEBYYOURAPP_ynh/tree/testing). +Please do your pull request to the [testing branch](https://github.com/YunoHost-Apps/yunomonitor_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/yunomonitor_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 yunomonitor -u https://github.com/YunoHost-Apps/yunomonitor_ynh/tree/testing --debug ```