electron/README.md

# Electron [![Build Status](https://travis-ci.org/atom/atom-shell.svg?branch=master)](https://travis-ci.org/atom/atom-shell)

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).

## Downloads

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

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

```
# Install globally in your $PATH
npm install atom-shell -g

# Install as a development dependency
npm install atom-shell --save-dev
```

### Mirrors

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

## Documentation

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

## Community

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