aaron/mattermost-desktop
1
0
Fork 0
Code Issues Pull requests Actions 2 Packages Projects Releases Wiki Activity

Merge pull request #755 from yuya-oc/update-readme

Browse source 
Update README.md
This commit is contained in:
Jason Blais 2018-04-09 09:56:17 -04:00 committed by GitHub
parent 31c4bb595f c52c6affa5
commit 33dd753972
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
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. On the first launch, 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:
@ -50,12 +49,13 @@ Configuration will be saved into Electron's userData directory:
Otherwise, you have to configure again.*
### Proxy
Normally, the application will follow your system settings to use proxy.
Or you can set proxy by following command line options.
Normally, the application will follow your system settings to use a proxy, or you can set up a proxy by the following command line options.
* `--proxy-server=<SERVER>:<PORT>`
* `--proxy-pac-url=<URL>`
On Windows, please make sure to add `--` before options. For example, `Mattermost.exe -- --proxy-server=...`.
## Contributing
Please see [CONTRIBUTING.md](./CONTRIBUTING.md).