diff --git a/README.md b/README.md index 1c0bb80..f8c3bb1 100644 --- a/README.md +++ b/README.md @@ -11,7 +11,7 @@ See https://ci-apps.yunohost.org/jenkins/job/mattermost%20(Community)/ for check Mattermost requires: * A x86_64 system (check with `uname -m`), -* Yunohost 2.6.4 or higher (check in Yunohost Admin panel), +* Yunohost 2.7 or higher (check in Yunohost Admin panel), * MySQL 5.6 or higher, or MariaDB 10 or higher (check with `mysql --version`). ## Installing @@ -19,7 +19,7 @@ Mattermost requires: You can either : * Install from the Yunohost Admin web interface, by providing this URL: `https://github.com/YunoHost-Apps/mattermost_ynh` -* Install from the command-line: `yunohost app install https://github.com/YunoHost-Apps/mattermost_ynh` +* Install from the command-line: `sudo yunohost app install https://github.com/YunoHost-Apps/mattermost_ynh` ## Upgrading @@ -32,15 +32,17 @@ Run the upgrade from Yunohost, then follow [this guide](https://docs.mattermost. * Installation on domain's root * Notification emails +* Push notifications +* Service control in Yunohost Services panel ## TODO -* Allow installation in sub-directory (only root-domains work for now) -* LDAP integration +* Allow installation in sub-directory (only root-domains for now, see [#8](https://github.com/YunoHost-Apps/mattermost_ynh/issues/8)) +* LDAP integration (only paid Entreprise Edition, see [#58](https://github.com/YunoHost-Apps/mattermost_ynh/issues/58)) ## About telemetrics -Mattermost is used to send some telemetrics about your usage of it. -But this data doesn't send to mattermost, but to a third party site named [segment.com](https://segment.com/). -You can find more information about his behavior on the [mattermost documentation](https://docs.mattermost.com/administration/telemetry.html). -This behavior can be turn on or off when you install this app. +Mattermost can collect some anonymous telemetrics about your usage of the software. These data are sent to a third-party service named [segment.com](https://segment.com/). +You can find more information about this behavior in the [Mattermost documentation](https://docs.mattermost.com/administration/telemetry.html). + +In this Yunohost package telemetrics collection is strictly opt-in, and can be turned on or off before the app is installed.