electron/README.md

[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/)

[![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron)
[![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies)
[![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/)

:zap: *formerly known as Atom Shell* :zap:

The Electron framework lets you write cross-platform desktop applications
using JavaScript, HTML and CSS. It is based on [io.js](http://iojs.org) and
[Chromium](http://www.chromium.org) and is used in the [Atom
editor](https://github.com/atom/atom).

Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
announcements.

## Downloads

Prebuilt binaries and debug symbols of Electron for Linux, Windows and Mac can
be found on the [releases](https://github.com/atom/electron/releases) page.

You can also use [`npm`](https://docs.npmjs.com/) to install prebuilt electron
binaries:

```sh
# 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

- [China](https://npm.taobao.org/mirrors/electron)

## Documentation

Guides and the API reference are located in the
[docs](https://github.com/atom/electron/tree/master/docs) directory. It also
contains documents describing how to build and contribute to Electron.

## Community

There is an [`electron` category on the Atom forums](http://discuss.atom.io/category/electron)
as well as an `#atom-shell` channel on Freenode.

Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron) for a community maintained list of useful example apps, tools and resources.
Logo png -> svg Fixes broken image in Readme 2015-04-28 14:48:54 +00:00			`[![Electron Logo](http://electron.atom.io/images/electron-logo.svg)](http://electron.atom.io/)`
Add Electron logo to Readme 2015-04-23 20:46:48 +00:00
:art: 2015-04-23 20:50:43 +00:00			`[![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron)`
Add david-dm dependency status badge to Readme 2015-04-23 21:00:40 +00:00			`[![devDependency Status](https://david-dm.org/atom/electron/dev-status.svg)](https://david-dm.org/atom/electron#info=devDependencies)`
Add slack back to README 2015-06-29 23:46:22 +00:00			`[![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/)`

Add mention of previous name 2015-04-20 18:22:50 +00:00			`:zap: formerly known as Atom Shell :zap:`

Atom Shell -> Electron 2015-04-08 17:16:10 +00:00			`The Electron framework lets you write cross-platform desktop applications`
Update README to replace node.js with io.js 2015-03-05 21:33:02 +00:00			`using JavaScript, HTML and CSS. It is based on [io.js](http://iojs.org) and`
Update readme 2014-05-05 18:56:35 +00:00			`[Chromium](http://www.chromium.org) and is used in the [Atom`
			`editor](https://github.com/atom/atom).`
Initial empty browser. 2013-04-12 01:46:58 +00:00
Mention new twitter account 2015-04-24 00:00:04 +00:00			`Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important`
			`announcements.`

:memo: A simpler README. 2014-05-04 12:58:59 +00:00			`## Downloads`
Initial empty browser. 2013-04-12 01:46:58 +00:00
docs: Update links in README The npm instructions are removed for now, will add it back when we had electron in npm registry. 2015-04-16 03:10:24 +00:00			`Prebuilt binaries and debug symbols of Electron for Linux, Windows and Mac can`
			`be found on the [releases](https://github.com/atom/electron/releases) page.`
add npm installation instructions to README 2015-02-26 05:56:47 +00:00
Add electron-prebuilt npm instructions to README 2015-04-17 18:25:06 +00:00			You can also use [`npm`](https://docs.npmjs.com/) to install prebuilt electron
			`binaries:`

Enable syntax highlighting in README Primarily to fade the comments in the code block 2015-04-29 17:56:31 +00:00			```sh
Add electron-prebuilt npm instructions to README 2015-04-17 18:25:06 +00:00			# Install the `electron` command globally in your $PATH
			`npm install electron-prebuilt -g`

			`# Install as a development dependency`
			`npm install electron-prebuilt --save-dev`
			```

Add China download mirrors 2015-01-19 14:30:33 +00:00			`### Mirrors`

Update China mirrors url fixes #1497 2015-05-10 08:15:12 +00:00			`- [China](https://npm.taobao.org/mirrors/electron)`
Add China download mirrors 2015-01-19 14:30:33 +00:00
Update readme 2014-05-05 18:56:35 +00:00			`## Documentation`
Initial empty browser. 2013-04-12 01:46:58 +00:00
Capitilization, grammar, and punctuation changes 2014-05-07 05:06:35 +00:00			`Guides and the API reference are located in the`
docs: Update links in README The npm instructions are removed for now, will add it back when we had electron in npm registry. 2015-04-16 03:10:24 +00:00			`[docs](https://github.com/atom/electron/tree/master/docs) directory. It also`
			`contains documents describing how to build and contribute to Electron.`
add community docs 2014-05-14 18:32:24 +00:00
			`## Community`

Update discuss category to electron 2015-04-20 16:34:32 +00:00			There is an [`electron` category on the Atom forums](http://discuss.atom.io/category/electron)
add community docs 2014-05-14 18:32:24 +00:00			as well as an `#atom-shell` channel on Freenode.
Add link to `awesome-electron` 2015-05-16 15:03:19 +00:00
			`Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron) for a community maintained list of useful example apps, tools and resources.`