From e6762b968a587a6f84791b77bcc44715ea2ae613 Mon Sep 17 00:00:00 2001 From: Yuya Ochiai Date: Tue, 3 Nov 2015 20:49:53 +0900 Subject: [PATCH] Update README.md --- README.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d4ccc1cd..8c00b3b8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,25 @@ # electron-mattermost -Desktop app for Mattermost that run on Electron +Desktop app for [Mattermost](http://www.mattermost.org/) that runs on [Electron](http://electron.atom.io/) -Mattermost: https://github.com/mattermost/platform +## Features +* Badges for unread channels +* Desktop notification +* Stay in taskbar (Windows) + +## Usage +1. Download and unarchive a file from [release page](http://github.com/yuya-oc/electron-mattermost/releases). +2. Launch electron-mattermost.exe or electron-mattermost.app +3. After first launching, please input URL for your Mattermost team. For exmaple, `http://mattermost.example.com/team`. +4. Ctrl or Command + Q to exit. + +Configuration will be saved into Electron's userData directory: +* `%APPDATA%\electron-mattermost` on Windows +* `~/Library/Application Support/electron-mattermost` on OS X +* `~/.config/electron-mattermost` on Linux + +## Testing +Node.js is required to test this app. + +1. Clone or download the source code. +2. Run `npm install`. +3. Run `npm start`. (If you have gulp, `gulp serve` has live-reload.)