From 2cfac58f2521f0b644235330a7ff9d9b0ec64293 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=A9r=C3=B4me=20Lebleu?= Date: Thu, 19 May 2016 21:20:17 +0200 Subject: [PATCH] [doc] Update README.md with features and for new app release --- README.md | 41 +++++++++++++++++------------------------ 1 file changed, 17 insertions(+), 24 deletions(-) diff --git a/README.md b/README.md index 030ab05..ea5ea6e 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,28 @@ Roundcube for YunoHost ---------------------- -*This is a work-in-progress package review to update Roundcube to 1.1.x -and make use of new YunoHost facilities - e.g. helpers - coming with 2.3.x.* - [Roundcube](https://roundcube.net/) is a browser-based multilingual IMAP client with an application-like user interface. **Shipped version:** 1.1.5 -## Installation +## Features -While it's merged to the official application list, you can install it in order -to try - or use it with caution! - either from the command line: +In addition to Roundcube core features, the following are made available with +this package: - $ sudo yunohost app install https://github.com/jeromelebleu/roundcube_ynh/tree/dev + * Integrate with YunoHost users and SSO - i.e. logout button, YunoHost users + search + * Synchronize your email aliases as identities in Roundcube + * Install the [contextmenu](https://plugins.roundcube.net/packages/johndoh/contextmenu) + and [automatic addressbook](https://plugins.roundcube.net/packages/sblaisot/automatic_addressbook) + plugins by default + * Allow to install the [CardDAV](https://plugins.roundcube.net/packages/roundcube/carddav) + (address book) synchronization plugin at the installation - note that if + you have installed ownCloud or Baïkal, it will automatically add the + corresponding and existing address book. -or from the Web administration: - - * Go to *Applications* - * Click on *Install* - * Scroll to the bottom of the page and put `https://github.com/jeromelebleu/roundcube_ynh/tree/dev` - under **Install custom app**. - -## Upgrade - -You can upgrade to this package from the command line for testing purpose with: - - $ sudo yunohost app upgrade -u https://github.com/jeromelebleu/roundcube_ynh/tree/dev roundcube - -## Extend and tweaks +## Extend and tweak ### Configuration @@ -83,6 +76,6 @@ case, do not forget to change ownerships to this folder to `www-data`. ## Links -**Roundcube**: https://roundcube.net/ - -**YunoHost**: https://yunohost.org/ + * Report a bug: https://dev.yunohost.org/projects/apps/issues + * Roundcube website: https://roundcube.net/ + * YunoHost website: https://yunohost.org/