add README

LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 rhysd
+
+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

@@ -0,0 +1,40 @@
+'About App' window for [Electron](https://github.com/atom/electron) apps
+========================================================================
+
+This package provides 'About This App' window for [Electron](https://github.com/atom/electron) applications.
+
+You can check [example app](example) to know how to use this package.  
+
+```sh
+$ git clone https://github.com/rhysd/about-window.git
+$ cd about-window
+$ npm run example
+```
+
+Only one function is exported as default.
+
+```typescript
+export default function openAboutWindow(
+    icon_path: string,
+    copyright: string,
+    homepage: string,
+    user_opt: BrowserWindowOptions = {}
+) : BrowserWindow
+```
+
+### Linux
+
+![Linux screenshot](https://raw.githubusercontent.com/rhysd/ss/master/about-window/about-window-linux.png)
+
+### OS X
+
+To be added.
+
+### Windows
+
+![Windows screenshot](https://raw.githubusercontent.com/rhysd/ss/master/about-window/about-window-windows.jpg)
+
+## License
+
+[MIT License](/LICENSE.txt).
+

example/main.js

@@ -11,7 +11,6 @@ app.once('ready', function() {
     var w = new BrowserWindow();
     w.once('closed', function() { w = null; });
     w.loadURL('file://' + join(__dirname, 'index.html'));
-    w.webContents.openDevTools({detach: true});
 
     const menu = Menu.buildFromTemplate([
         {

package.json

@@ -4,7 +4,7 @@
   "description": "'About App' window for Electron application",
   "scripts": {
     "dep": "npm install && $(npm bin)/tsd install",
-    "example": "npm run dep && $(npm bin)/electron $(npm root)/example"
+    "example": "npm run dep && $(npm bin)/electron $(npm prefix)/example"
   },
   "repository": {
     "type": "git",