Update README.md

This commit is contained in:
Yuya Ochiai 2018-04-09 22:40:46 +09:00
parent 31c4bb595f
commit 2f9ad442e8

View file

@ -14,7 +14,7 @@ Originally created as "electron-mattermost" by Yuya Ochiai. Developed using [Ele
* Tabs for multiple teams across multiple servers
* Desktop Notifications
* Windows 10: Toast
* Windows 7-8.1: Balloon (fallback behavior, so lesser support)
* Windows 7-8.1: Popup like Toast
* OS X: Notification Center
* Linux: [libnotify](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux)
* Badges for unread channels and mentions
@ -31,14 +31,13 @@ Detailed guides are available at [docs.mattermost.com](https://about.mattermost.
1. Download a file from the [downloads page](https://about.mattermost.com/downloads).
2. Launch `Mattermost` in the unarchived folder.
3. After first launching, please input name and URL for your Mattermost team. For example, `myteam : https://mattermost.example.com/team`.
3. After first launching, please input name and URL for your Mattermost server. For example, `myserver : https://mattermost.example.com`.
### Quit
Ctrl or Command + Q to quit.
### Configuration
You can show the dialog from menu bar.
(Please press Alt key to show the menu bar if it disappers.)
Configuration will be saved into Electron's userData directory:
@ -56,6 +55,8 @@ Or you can set proxy by following command line options.
* `--proxy-server=<SERVER>:<PORT>`
* `--proxy-pac-url=<URL>`
On Windows, please make sure adding `--` before options. For example, `Mattermost.exe -- --proxy-server=...`.
## Contributing
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).