diff --git a/npm/CONTRIBUTING.md b/npm/CONTRIBUTING.md index 97cd1958d5..c240215661 100644 --- a/npm/CONTRIBUTING.md +++ b/npm/CONTRIBUTING.md @@ -1,3 +1,5 @@ +releases for this module are handled by https://github.com/johnmuhl/electron-prebuilt-updater + versions published to npm should match the versions published to [github releases for electron](https://github.com/atom/electron/releases) coding style should be `standard`: diff --git a/npm/LICENSE b/npm/LICENSE new file mode 100644 index 0000000000..5e3984a8fb --- /dev/null +++ b/npm/LICENSE @@ -0,0 +1,7 @@ +Copyright (c) 2015 Mathias Buus-Madsen, Max Ogden and contributors + +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. \ No newline at end of file diff --git a/npm/README.md b/npm/README.md index a78dad2100..8d23ff6e78 100644 --- a/npm/README.md +++ b/npm/README.md @@ -3,9 +3,9 @@ [![build status](http://img.shields.io/travis/mafintosh/electron-prebuilt.svg?style=flat)](http://travis-ci.org/mafintosh/electron-prebuilt) [![dat](http://img.shields.io/badge/Development%20sponsored%20by-dat-green.svg?style=flat)](http://dat-data.com/) -Install [electron](https://github.com/atom/electron) prebuilt binaries for command-line use using npm. This module helps you easily install the `electron` command for use on the command line without having to compile anything. +![badge](https://nodei.co/npm/electron-prebuilt.png?downloads=true) -Works on Mac, Windows and Linux OSes that Electron supports (e.g. Electron [does not support Windows XP](https://github.com/atom/electron/issues/691)). +Install [electron](https://github.com/atom/electron) prebuilt binaries for command-line use using npm. This module helps you easily install the `electron` command for use on the command line without having to compile anything. Electron is a JavaScript runtime that bundles Node.js and Chromium. You use it similar to the `node` command on the command line for executing JavaScript programs. For more info you can read [this intro blog post](http://maxogden.com/electron-fundamentals.html) or dive into the [Electron documentation](https://github.com/atom/electron/tree/master/docs) @@ -39,6 +39,14 @@ electron If you need to use an HTTP proxy you can [set these environment variables](https://github.com/request/request/tree/f0c4ec061141051988d1216c24936ad2e7d5c45d#controlling-proxy-behaviour-using-environment-variables) +## About + +Works on Mac, Windows and Linux OSes that Electron supports (e.g. Electron [does not support Windows XP](https://github.com/atom/electron/issues/691)). + +The version numbers of this module match the version number of the [offical Electron releases](https://github.com/atom/electron/releases), which do not follow [semantic versioning](http://semver.org/). + +This module is automatically released whenever a new version of Electron is released thanks to [electron-prebuilt-updater](https://github.com/johnmuhl/electron-prebuilt-updater) written by [John Muhl](https://github.com/johnmuhl/). + ## Usage First you have to [write an electron application](https://github.com/atom/electron/blob/master/docs/tutorial/quick-start.md) @@ -49,6 +57,14 @@ Then you can run your app using: electron your-app/ ``` +## Related modules + +- [electron-packager](https://github.com/maxogden/electron-packager) - package and distribute your electron app in OS executables (.app, .exe etc) +- [electron-builder](https://github.com/loopline-systems/electron-builder) - create installers for Windows and OS X. It's built to work together with electron-packager +- [menubar](https://github.com/maxogden/menubar) - high level way to create menubar desktop applications with electron + +Find more at the [awesome-electron](https://github.com/sindresorhus/awesome-electron) list + ## Programmatic usage Most people use this from the command line, but if you require `electron-prebuilt` inside your node app it will return the file path to the binary. diff --git a/npm/package.json b/npm/package.json index 791fe0e97e..44a9814821 100644 --- a/npm/package.json +++ b/npm/package.json @@ -1,7 +1,7 @@ { "name": "electron-prebuilt", "version": "0.31.0", - "description": "Install electron (formerly called atom-shell) prebuilts using npm", + "description": "Install electron (formerly called atom-shell) prebuilt binaries for command-line use using npm", "repository": { "type": "git", "url": "https://github.com/mafintosh/electron-prebuilt"