add license and update readme

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Tim Cheung <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,73 +1,58 @@
 # <img src=".github/gmail-logo.png" width="45"> Gmail Desktop
 
-[![Travis](https://travis-ci.org/timche/gmail-desktop.svg?branch=master)](https://travis-ci.org/timche/gmail-desktop) [![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) [![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
+[![Travis](https://travis-ci.org/timche/gmail-desktop.svg?branch=master)](https://travis-ci.org/timche/gmail-desktop) [![XO Code Style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo) [![Styled with Prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
 
-> An unofficial Gmail Desktop App built with [Electron](https://github.com/electron/electron)
+> Gmail Desktop App built with [Electron](https://github.com/electron/electron)
 
 ![Gmail Desktop Screenshot](.github/screenshot.png)
 
-## Why?
-If you are only using the Gmail website like me, then is this app just for you! It's just a wrapper around the Gmail website with some magic from Electron like native notifications or unread mails badge in the dock.
-
 ## Features
-- [x] Original Gmail Interface
-- [x] Native Notifications
-- [x] Unread Inbox Count (OS X only)
-- [ ] Multiple Gmail Accounts
 
-## Supported OS
-- [x] OS X 10.9+
-- [ ] Windows 7+ (not tested yet)
-- [ ] Linux (not tested yet)
+- Original Gmail Interface
+- Native Notifications
+- Unread Inbox Count (macOS only)
 
 ## Installation
 
-#### OS X
-1. [Download latest release](https://github.com/timche/gmail-desktop/releases).
-1. Unzip it.
-1. Move `Gmail Desktop.app` to `/Applications`.
+*Only macOS 10.9+ is currently supported.*
 
-## Development
-Gmail Desktop is built with [Electron](https://github.com/electron/electron).
+#### macOS
 
-#### Commands
-- **Install npm dependencies:**
+1. [Download latest release](https://github.com/timche/gmail-desktop/releases) (`Gmail-Desktop-macOS-X.X.X.zip`).
+1. Unzip it.
+1. Move `Gmail Desktop.app` to `/Applications`.
 
-  ```bash
-  $ npm install
-  ```
+## Developing
 
-- **Run the app:**
+Built with [Electron](https://github.com/electron/electron).
 
-  ```bash
-  $ npm start
-  ```
+#### Install
 
-- **Lint:**
+```sh
+npm install
+```
 
-  ```bash
-  $ npm run lint
-  ```
+#### Run
 
-- **Build OS X:**
+```sh
+npm start
+```
 
-  ```bash
-  $ npm run build:osx
-  ```
+#### Build
 
-- **Build all platforms:**
+```sh
+# All platforms
+npm run build
 
-  ```bash
-  $ npm run build
-  ```
+# macOS
+npm run build:macos
+```
 
 ## To-Do
-- [ ] Ability to use multiple Gmail accounts.
-- [ ] Adjust OS X window buttons, so they don't overlay the Google Logo.
-- [ ] Add Auto Updater.
+
+- [ ] Ability to use multiple Gmail accounts
+- [ ] Add Auto Updater
 
 ## Contributing
-Any contributions and suggestions are greatly appreciated! 🤗 🎉
 
-## License
-MIT © [Tim Cheung](https://github.com/timche)
+Any contributions and suggestions are highly appreciated! 🤗 🎉

package.json

@@ -11,8 +11,8 @@
     "prettier": "prettier --no-semi --single-quote --write",
     "prettify": "npm run prettier -- src/*.js",
     "start": "electron .",
-    "build:osx": "electron-packager . --out=build --overwrite --platform=darwin --arch=x64 --app-version=$npm_package_version --icon=assets/icon.icns  --protocol-name=\"Email Address URL\" --protocol=\"mailto\"",
-    "build": "npm run build:osx"
+    "build:macos": "electron-packager . --out=build --overwrite --platform=darwin --arch=x64 --app-version=$npm_package_version --icon=assets/icon.icns  --protocol-name=\"Email Address URL\" --protocol=\"mailto\"",
+    "build": "npm run build:macos"
   },
   "repository": "timche/gmail-desktop",
   "author": "Tim Cheung <[email protected]>",