From 56db5dc34184877b005f86444bd240c71bbc827a Mon Sep 17 00:00:00 2001 From: ABHAMON Ronan Date: Thu, 26 Nov 2015 10:39:48 +0100 Subject: [PATCH] Update README --- packages/xo-server-backup-reports/README.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/packages/xo-server-backup-reports/README.md b/packages/xo-server-backup-reports/README.md index 289f7d4a9..ec6904d33 100644 --- a/packages/xo-server-backup-reports/README.md +++ b/packages/xo-server-backup-reports/README.md @@ -2,11 +2,11 @@ > Backup reports plugin for XO-Server -This plugin allows to receive email notifications when backups jobs are done. +This plugin allows to receive email notifications when backup's jobs are done. ## Install -Installation of the [npm package](https://npmjs.org/package/${pkg.name}): +Installation of the [npm package](https://npmjs.org/package/xo-server-backup-reports): ``` > npm install --global xo-server-backup-reports @@ -14,7 +14,22 @@ Installation of the [npm package](https://npmjs.org/package/${pkg.name}): ## Usage -**TODO** +### Prerequisite + +You must have the [xo-server-transport-email](https://github.com/vatesfr/xo-server-transport-email) plugin enabled to use xo-server-backup-reports. + +### Add the plugin to XO-Server config + +```yaml +plugins: + + xo-server-backup-reports: + + # Receivers of notifications + to: + # Define your receivers here using brackets like this: + # [email1, email2, ...] +``` ## Development