diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..da82d9a --- /dev/null +++ b/readme.md @@ -0,0 +1,28 @@ +# electron-boilerplate + +> Boilerplate to kickstart creating an app with [Electron](https://github.com/atom/electron) *(formerly atom-shell)* + +*See [awesome-electron](https://github.com/sindresorhus/awesome-electron) for more useful Electron resources.* + + +## Getting started + +In your directory, run: + +``` +$ curl -fsSL https://github.com/sindresorhus/electron-boilerplate/archive/master.tar.gz | tar -xz --strip-components 2 +``` + +You can also `git clone` or [download](https://github.com/sindresorhus/electron-boilerplate/archive/master.zip) this repo and get contents of the `boilerplate` folder. + +There's also a [Yeoman generator](https://github.com/sindresorhus/generator-electron). + + +## Caveats + +Only OS X is supported for the `$ npm run build` command for now, see [atom-shell-packager#3](https://github.com/maxogden/atom-shell-packager/issues/3). + + +## License + +MIT © [Sindre Sorhus](http://sindresorhus.com) |