diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index feb1ed68..78e38088 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,8 @@ Following points are very helpful to understand the problem. * How to reproduce, step-by-step * Expected behavior (or what is wrong) * Screenshots (for GUI issues) -* electron-mattermost version -* OS +* Application version +* Operating system * Mattermost version ## Feature idea diff --git a/README.md b/README.md index 521209a7..ffd53707 100644 --- a/README.md +++ b/README.md @@ -23,28 +23,32 @@ Originally created as "electron-mattermost" by Yuya Ochiai. Developed using [Ele ### Pre-packaged You don't have to install any other software. -Packages are available on the [releases page](http://github.com/yuya-oc/electron-mattermost/releases). +Packages are available on the [releases page](http://github.com/mattermost/desktop/releases). ## Usage ### Installation Detailed guides are available at [docs/setup.md](docs/setup.md). -1. Download and unarchive a file from [release page](http://github.com/yuya-oc/electron-mattermost/releases). -2. Launch `electron-mattermost` in the unarchived folder. -3. After first launching, please input name and URL for your Mattermost team. For example, `myteam : http://mattermost.example.com/team`. +1. Download and unarchive a file from [release page](http://github.com/mattermost/desktop/releases). +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`. ### Quit Ctrl or Command + Q to quit. ### Configuration You can show the dialog from menu bar. -(On Windows, please press Alt key to show the menu bar.) +(Please press Alt key to show the menu bar if it disappers.) 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 + +* `%APPDATA%\Mattermost` on Windows +* `~/Library/Application Support/Mattermost` on OS X +* `~/.config/Mattermost` on Linux + +*When you upgrade from electron-mattermost, please copy `config.json` from `electron-mattermost`. +Otherwise, you have to configure again.* ## Testing and Development Node.js is required to test this app. diff --git a/docs/setup.md b/docs/setup.md index d7299f5b..6f2ed1c3 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -1,10 +1,10 @@ -# Electron-Mattermost Setup Guides +# Mattermost Desktop Setup Guides ## Step-by-step Windows setup -To set up the Mattermost desktop application for Windows 7, 8 and 10: +To set up the Mattermost desktop application for Windows 7, 8 and 10: -1. Download [the latest release](https://github.com/yuya-oc/electron-mattermost/releases) of electron-attermost +1. Download [the latest release](https://github.com/mattermost/desktop/releases) of Mattermost Desktop Find the file ending in `-win64.zip` if you're running a x64 version of Windows and `-win32.zip` if you're running an older 32-bit version. @@ -12,11 +12,11 @@ To set up the Mattermost desktop application for Windows 7, 8 and 10: A new directory should be created on your PC. -3. Go to `/electron-mattermost...` directory and find the file named `electron-mattermost` +3. Go to `/mattermost-desktop...` directory and find the file named `Mattermost` - - Right-click the file and select "Pin to Taskbar" to make the application available from your Windows task bar. - - Right-click the file and select "Pin to Start Menu" to make the application available from your Windows Start menu. - - Double-click the file to open the application. + - Right-click the file and select "Pin to Taskbar" to make the application available from your Windows task bar. + - Right-click the file and select "Pin to Start Menu" to make the application available from your Windows Start menu. + - Double-click the file to open the application. 4. After opening the application, press `Alt` key to bring up the menu at the top of the window, then click `File -> Settings` @@ -28,26 +28,26 @@ To set up the Mattermost desktop application for Windows 7, 8 and 10: To quit, use `Ctrl+Q` -## Help +## Help -See the Mattermost [help documention](http://docs.mattermost.com/help/getting-started/signing-in.html) for how to use the Mattermost team site. +See the Mattermost [help documention](http://docs.mattermost.com/help/getting-started/signing-in.html) for how to use the Mattermost team site. -The Mattermost application works in place of a web browser to access your different Mattermost Team Sites, and is controled by a menu bar available from the top of the application. +The Mattermost application works in place of a web browser to access your different Mattermost Team Sites, and is controled by a menu bar available from the top of the application. -### Top Menu: +### Top Menu: -Click the `Alt` key to toggle the menu on and off. +Click the `Alt` key to toggle the menu on and off. -Below lists menu options (shortcut keys are listed in brackets): +Below lists menu options (shortcut keys are listed in brackets): - **File** - - **About electron-mattermost** - Shows version information for Mattermost desktop application + - **About Mattermost** - Shows version information for Mattermost desktop application - **Settings** - Opens setting menu to add new team sites and configure shortcut key options - - **Quit** (Ctrl+Q) - Exits the application + - **Quit** (Ctrl+Q) - Exits the application - **Edit** - - **Undo** (Ctrl+Z) - Reverses previous action + - **Undo** (Ctrl+Z) - Reverses previous action - **Redo** (Ctrl+Shift+Z) - Replays most recent action - - **Cut** (Ctrl+X) - Cuts selected text + - **Cut** (Ctrl+X) - Cuts selected text - **Copy** (Ctrl+C) - Copies selected text - **Paste** (Ctrl+V) - Pastes text from clipboard - **Select All** (Ctrl+A) - Select all text in input box @@ -60,7 +60,7 @@ Below lists menu options (shortcut keys are listed in brackets): ## Step-by-step OS X setup For OS X 10.11 El Capitan. An older version of OS X has similar way. -1. Download [the latest release](https://github.com/yuya-oc/electron-mattermost/releases) of electron-mattermost +1. Download [the latest release](https://github.com/mattermost/desktop/releases) of Mattermost Desktop Find the file ending in `-osx.tar.gz`. @@ -68,13 +68,13 @@ For OS X 10.11 El Capitan. An older version of OS X has similar way. A new directory should be created on your Mac. -3. Go to `/electron-mattermost...` directory and right-click on `electron-mattermost` package and select "Open" +3. Go to `/mattermost-desktop...` directory and right-click on `Mattermost` package and select "Open" If you see a dialog to confirm the application, select "Open". - You should see a new application called **electron-mattermost** open. + You should see a new application called **Mattermost Desktop** open. -4. Click `electron-mattermost` from the menu at the top of the screen, then click `Settings` +4. Click `Mattermost` from the menu at the top of the screen, then click `Settings` 5. For each Mattermost team you'd like to use, enter its **Name** and **URL** then click **Add**