4bc9bf7654
Remote is a great feature, it's a shame to put people off unnecessarily. I think the original warnings given are too extreme The potential bugs that stem from not cleaning up event handlers (or any reference) are present in any Javascript code. We don't avoid using event-handlers in the DOM because we might forget to clean them up! I've added an example of the behaviour of return values from synchronously called callbacks from renderer, and have changed the advice from 'you shouldn't do this' to 'be careful when you do this'.
⚡ formerly known as Atom Shell ⚡
The Electron framework lets you write cross-platform desktop applications using JavaScript, HTML and CSS. It is based on io.js and Chromium and is used in the Atom editor.
Follow @ElectronJS on Twitter for important announcements.
This project adheres to the Contributor Covenant 1.2. By participating, you are expected to uphold this code. Please report unacceptable behavior to atom@github.com.
Downloads
Prebuilt binaries and debug symbols of Electron for Linux, Windows and Mac can be found on the releases page.
You can also use npm to install prebuilt electron
binaries:
# Install the `electron` command globally in your $PATH
npm install electron-prebuilt -g
# Install as a development dependency
npm install electron-prebuilt --save-dev
Mirrors
Documentation
Guides and the API reference are located in the docs directory. It also contains documents describing how to build and contribute to Electron.
Documentation Translations
Community
There is an electron category on the Atom forums
as well as an #atom-shell channel on Freenode.
Check out awesome-electron for a community maintained list of useful example apps, tools and resources.