README.md

   1 [![Electron Logo](https://electron.atom.io/images/electron-logo.svg)](https://electron.atom.io/)
   2
   3 [![Travis Build Status](https://travis-ci.org/electron/electron.svg?branch=master)](https://travis-ci.org/electron/electron)
   4 [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/bc56v83355fi3369/branch/master?svg=true)](https://ci.appveyor.com/project/electron-bot/electron/branch/master)
   5 [![devDependency Status](https://david-dm.org/electron/electron/dev-status.svg)](https://david-dm.org/electron/electron?type=dev)
   6 [![Join the Electron Community on Slack](http://atom-slack.herokuapp.com/badge.svg)](http://atom-slack.herokuapp.com/)
   7
   8 :memo: Available Translations: [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR/project/README.md) | [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN/project/README.md) | [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR/project/README.md) | [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW/project/README.md) | [Spanish](https://github.com/electron/electron/tree/master/docs-translations/es/project/README.md) | [Turkish](https://github.com/electron/electron/tree/master/docs-translations/tr-TR/project/README.md)
   9
  10 The Electron framework lets you write cross-platform desktop applications
  11 using JavaScript, HTML and CSS. It is based on [Node.js](https://nodejs.org/) and
  12 [Chromium](http://www.chromium.org) and is used by the [Atom
  13 editor](https://github.com/atom/atom) and many other [apps](https://electron.atom.io/apps).
  14
  15 Follow [@ElectronJS](https://twitter.com/electronjs) on Twitter for important
  16 announcements.
  17
  18 This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
  19 By participating, you are expected to uphold this code. Please report unacceptable
  20 behavior to electron@github.com.
  21
  22 ## Downloads
  23
  24 To install prebuilt Electron binaries, use
  25 [`npm`](https://docs.npmjs.com/):
  26
  27 ```sh
  28 # Install as a development dependency
  29 npm install electron --save-dev
  30
  31 # Install the `electron` command globally in your $PATH
  32 npm install electron -g
  33 ```
  34
  35 See the [releases page](https://github.com/electron/electron/releases) for
  36 prebuilt binaries, debug symbols, and more.
  37
  38 ### Mirrors
  39
  40 - [China](https://npm.taobao.org/mirrors/electron)
  41
  42 ## Documentation
  43
  44 Guides and the API reference are located in the
  45 [docs](https://github.com/electron/electron/tree/master/docs) directory. It also
  46 contains documents describing how to build and contribute to Electron.
  47
  48 ## Documentation Translations
  49
  50 - [Brazilian Portuguese](https://github.com/electron/electron/tree/master/docs-translations/pt-BR)
  51 - [Korean](https://github.com/electron/electron/tree/master/docs-translations/ko-KR)
  52 - [Japanese](https://github.com/electron/electron/tree/master/docs-translations/jp)
  53 - [Spanish](https://github.com/electron/electron/tree/master/docs-translations/es)
  54 - [Simplified Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-CN)
  55 - [Traditional Chinese](https://github.com/electron/electron/tree/master/docs-translations/zh-TW)
  56 - [Turkish](https://github.com/electron/electron/tree/master/docs-translations/tr-TR)
  57 - [Thai](https://github.com/electron/electron/tree/master/docs-Translations/th-TH)
  58 - [Ukrainian](https://github.com/electron/electron/tree/master/docs-translations/uk-UA)
  59 - [Russian](https://github.com/electron/electron/tree/master/docs-translations/ru-RU)
  60 - [French](https://github.com/electron/electron/tree/master/docs-translations/fr-FR)
  61
  62 ## Quick Start
  63
  64 Clone and run the [`electron/electron-quick-start`](https://github.com/electron/electron-quick-start)
  65 repository to see a minimal Electron app in action.
  66
  67 ## Community
  68
  69 You can ask questions and interact with the community in the following
  70 locations:
  71 - [`electron`](http://discuss.atom.io/c/electron) category on the Atom
  72 forums
  73 - `#atom-shell` channel on Freenode
  74 - [`Atom`](http://atom-slack.herokuapp.com/) channel on Slack
  75 - [`electron-br`](https://electron-br.slack.com) *(Brazilian Portuguese)*
  76 - [`electron-kr`](http://www.meetup.com/electron-kr/) *(Korean)*
  77 - [`electron-jp`](https://electron-jp.slack.com) *(Japanese)*
  78 - [`electron-tr`](https://electron-tr.slack.com) *(Turkish)*
  79 - [`electron-id`](https://electron-id.slack.com) *(Indonesia)*
  80
  81 Check out [awesome-electron](https://github.com/sindresorhus/awesome-electron)
  82 for a community maintained list of useful example apps, tools and resources.
  83
  84 ## License
  85
  86 [MIT](https://github.com/electron/electron/blob/master/LICENSE)
  87
  88 When using the Electron or other GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos).