README.md
⚡ 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 [Open Code of Conduct][code-of-conduct]. By participating, you are expected to uphold this code. [code-of-conduct]: http://todogroup.org/opencodeofconduct/#Electron/opensource@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.
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.