diff --git a/README.md b/README.md index 950fb818..1ca402f6 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,37 @@ # electron-mattermost Desktop app for [Mattermost](http://www.mattermost.org/) that runs on [Electron](http://electron.atom.io/) + ## Features + +### Desktop integration * Badges for unread channels -* Desktop notification -* Stay in taskbar (Windows) +* Notification + * Windows: Balloon or Toast + * OS X: Notification Center +* Resident application + +### Pre-packaged +You don't have to install any other software. + ## Usage + +### Installation 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. +### Quit +Ctrl or Command + Q to quit. + +### Configuration 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. @@ -24,6 +39,7 @@ Node.js is required to test this app. 2. Run `npm install`. 3. Run `npm start`. (If you have gulp, `gulp serve` has live-reload.) + ## Packaging gulp is necessary for packaging this app.