Skip to content

Rename Atom Shell to Electron #23

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 1, 2015
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion guides/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Learning NodeGit

- [Basics](install/)
- [From source](install/from-source)
- [Atom Shell](install/atom-shell/)
- [Electron](install/electron/)
- [NW.js](install/nw.js/)

***
Expand Down
35 changes: 0 additions & 35 deletions guides/install/atom-shell/index.md

This file was deleted.

35 changes: 35 additions & 0 deletions guides/install/electron/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
layout: full
menu_item: guides
title: Electron
description: How to install NodeGit with Electron
---

[Return to all guides](../../)

* * *

Install for Electron
----------------------

For an application that is built using [Electron](https://github.com/atom/Electron) you'll need to have the `engines.electron` set to the version of Electron that you are targeting in your root `package.json` file.

For example if you have an Electron app that's targeting version 0.20.7 your package.json file would look something like:

```json
{
"name": "elec-app",
"displayName": "My Electron app",
"version": "0.0.1",
"description": "",
"main": "main.js",
"author": "",
"engines": {
"electron": "0.20.7"
}
}
```

And when doing an `npm install` or `apm install` inside of your Electron's root folder it will compile NodeGit targeting that version of Electron during the install.

*NOTE: there are no pre-built binaries for Electron, you must rebuild NodeGit. Visit our [building guides](../from-source) for help*
Binary file removed img/atom.png
Binary file not shown.
15 changes: 15 additions & 0 deletions img/electron.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,11 @@ npm install nodegit
<h3>Native Shells</h3>
<div class="columns">
<div class="column">
<a href="http://github.com/atom/atom-shell">
<img src="/img/atom.png"/>
<a href="http://github.com/atom/electron">
<img src="/img/electron.svg"/>
</a>
<a href="/guides/install/atom-shell/">
Atom
<a href="/guides/install/electron/">
Electron
</a>
</div>
<div class="column">
Expand Down