electron/README.md

27 lines
987 B
Markdown
Raw Normal View History

# Electron [![Build Status](https://travis-ci.org/atom/electron.svg?branch=master)](https://travis-ci.org/atom/electron)
2014-05-05 21:19:16 +00:00
2015-04-08 17:16:10 +00:00
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
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).
2013-04-12 01:46:58 +00:00
2014-05-04 12:58:59 +00:00
## Downloads
2013-04-12 01:46:58 +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.
2015-01-19 14:30:33 +00:00
### Mirrors
2015-03-28 22:34:59 +00:00
- [China](https://npm.taobao.org/mirrors/atom-shell)
2015-01-19 14:30:33 +00:00
2014-05-05 18:56:35 +00:00
## Documentation
2013-04-12 01:46:58 +00:00
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.
2014-05-14 18:32:24 +00:00
## 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.