Update README.md
This commit is contained in:
22
README.md
22
README.md
@@ -1,22 +1,37 @@
|
|||||||
# electron-mattermost
|
# electron-mattermost
|
||||||
Desktop app for [Mattermost](http://www.mattermost.org/) that runs on [Electron](http://electron.atom.io/)
|
Desktop app for [Mattermost](http://www.mattermost.org/) that runs on [Electron](http://electron.atom.io/)
|
||||||
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
### Desktop integration
|
||||||
* Badges for unread channels
|
* Badges for unread channels
|
||||||
* Desktop notification
|
* Notification
|
||||||
* Stay in taskbar (Windows)
|
* Windows: Balloon or Toast
|
||||||
|
* OS X: Notification Center
|
||||||
|
* Resident application
|
||||||
|
|
||||||
|
### Pre-packaged
|
||||||
|
You don't have to install any other software.
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
|
### Installation
|
||||||
1. Download and unarchive a file from [release page](http://github.com/yuya-oc/electron-mattermost/releases).
|
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
|
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`.
|
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:
|
Configuration will be saved into Electron's userData directory:
|
||||||
* `%APPDATA%\electron-mattermost` on Windows
|
* `%APPDATA%\electron-mattermost` on Windows
|
||||||
* `~/Library/Application Support/electron-mattermost` on OS X
|
* `~/Library/Application Support/electron-mattermost` on OS X
|
||||||
* `~/.config/electron-mattermost` on Linux
|
* `~/.config/electron-mattermost` on Linux
|
||||||
|
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
Node.js is required to test this app.
|
Node.js is required to test this app.
|
||||||
|
|
||||||
@@ -24,6 +39,7 @@ Node.js is required to test this app.
|
|||||||
2. Run `npm install`.
|
2. Run `npm install`.
|
||||||
3. Run `npm start`. (If you have gulp, `gulp serve` has live-reload.)
|
3. Run `npm start`. (If you have gulp, `gulp serve` has live-reload.)
|
||||||
|
|
||||||
|
|
||||||
## Packaging
|
## Packaging
|
||||||
gulp is necessary for packaging this app.
|
gulp is necessary for packaging this app.
|
||||||
|
|
||||||
|
Reference in New Issue
Block a user