phlux/mattermostest
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Merge pull request #61 from mattermost/README-tweaks

Browse Source 
Proposing minor README changes
This commit is contained in:
Yuya Ochiai
2016-03-10 21:48:30 +09:00
parent 05f55aac9e f7c1be1268
commit 2646df05cd
1 changed files with 9 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -2,29 +2,27 @@
Native desktop application for [Mattermost](http://www.mattermost.org/) running on Windows, Mac and Linux. Native desktop application for [Mattermost](http://www.mattermost.org/) running on Windows, Mac and Linux.
Originally created as "electron-mattermost" by Yuya Ochiai Originally created as "electron-mattermost" by Yuya Ochiai. Developed using [Electron](http://electron.atom.io/).
![s](https://raw.githubusercontent.com/mattermost/desktop/rename-1/docs/20160309_mattermost-desktop.gif) ![s](https://raw.githubusercontent.com/mattermost/desktop/rename-1/docs/20160309_mattermost-desktop.gif)
[![Circle CI](https://circleci.com/gh/yuya-oc/electron-mattermost.svg?style=svg)](https://circleci.com/gh/yuya-oc/electron-mattermost) [![Circle CI](https://circleci.com/gh/yuya-oc/electron-mattermost.svg?style=svg)](https://circleci.com/gh/yuya-oc/electron-mattermost)
[Electron](http://electron.atom.io/)-based desktop application for [Mattermost](http://www.mattermost.org/)
## Features ## Features
### Desktop integration ### Desktop integration
* Tabs for multiple teams * Tabs for multiple teams across multiple servers
* Desktop Notification * Desktop Notifications
* Windows 10: Toast * Windows 10: Toast
* Windows 7-8.1: Balloon (fallback behavior, so lesser support) * Windows 7-8.1: Balloon (fallback behavior, so lesser support)
* OS X: Notification Center * OS X: Notification Center
* Linux: libnotify ([Electron's notification spec](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux)) * Linux: [libnotify](http://electron.atom.io/docs/v0.36.0/tutorial/desktop-environment-integration/#linux)
* Badges for unread channels and mention * Badges for unread channels and mentions
* Resident application * Installs as native application
### Pre-packaged ### Pre-packaged
You don't have to install any other software. You don't have to install any other software.
Packages are available at [release page](http://github.com/yuya-oc/electron-mattermost/releases). Packages are available on the [releases page](http://github.com/yuya-oc/electron-mattermost/releases).
## Usage ## Usage
@@ -47,7 +45,6 @@ Configuration will be saved into Electron's userData directory:
* `~/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 and Development ## Testing and Development
Node.js is required to test this app. Node.js is required to test this app.
@@ -59,10 +56,10 @@ Node.js is required to test this app.
When you edit `src/**` files, please execute `npm run build` before `npm start`. When you edit `src/**` files, please execute `npm run build` before `npm start`.
### Development ### Development
#### `npm run watch` ###### `npm run watch`
Reload the app automatically when you have saved source codes. Reload the app automatically when you have saved source codes.
#### `npm test` ###### `npm test`
Run tests with Mocha. Run tests with Mocha.
## Packaging ## Packaging