From 8a0f37f51977754d9c17da455c189451d6365ef7 Mon Sep 17 00:00:00 2001 From: Valentino Pesce Date: Mon, 31 Dec 2018 10:50:00 +0100 Subject: [PATCH] Update README.md --- README.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/README.md b/README.md index c862d59..5477142 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,42 @@ +[![GitHub license](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/kenlog/SoundNotification/blob/master/LICENSE) +[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/kenlog/SoundNotification/graphs/contributors) +[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)]() + # Sound notification for kanboard :sound: - Each new notification will sound an alert sound ###### it works only with active web notifications + +Author +------------ +- Valentino Pesce +- License MIT + +Requirements +------------ +Kanboard >= v1.0.48 +Kanboard installed at a web server. +You can find the download at [kanboard.org](https://kanboard.org/) + +Installation +------------ +You have the choice between 3 methods: + +1. Install the plugin from the Kanboard plugin manager in one click +2. Download the zip file and decompress everything under the directory `plugins/SoundNotification` +3. Clone this repository into the folder `plugins/SoundNotification` + +Note: Plugin folder is case-sensitive. + +### :star: If you like it, do not forget to give a star on GitHub! + +:construction_worker: Any contribution will be highly appreciated +------------ +Clone the repository: +```console +git clone https://github.com/kenlog/SoundNotification.git +``` +:bug: Reporting Issues +------------ +Please [create an issue](https://github.com/kenlog/SoundNotification/issues) for any bugs you've found.