diff --git a/guides/index.md b/guides/index.md index 8b827b8..e4a2bdf 100644 --- a/guides/index.md +++ b/guides/index.md @@ -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/) *** diff --git a/guides/install/atom-shell/index.md b/guides/install/atom-shell/index.md deleted file mode 100644 index cdf3877..0000000 --- a/guides/install/atom-shell/index.md +++ /dev/null @@ -1,35 +0,0 @@ ---- -layout: full -menu_item: guides -title: Atom Shell -description: How to install NodeGit with Atom Shell ---- - -[Return to all guides](../../) - -* * * - -Install for atom-shell ----------------------- - -For an application that is built using [atom-shell](https://github.com/atom/atom-shell) you'll need to have the `engines.atom-shell` set to the version of atom-shell that you are targeting in your root `package.json` file. - -For example if you have an atom-shell app that's targeting version 0.20.7 your package.json file would look something like - -```json -{ - "name": "as-app", - "displayName": "My Atom Shell app", - "version": "0.0.1", - "description": "", - "main": "main.js", - "author": "", - "engines": { - "atom-shell": "0.20.7" - } -} -``` - -And when doing an `npm install` or `apm install` inside of your atom-shell's root folder it will compile NodeGit targeting that version of atom-shell during the install. - -*NOTE: there are no pre-built binaries for atom-shell, you must rebuild NodeGit. Visit our [building guides](../from-source) for help* diff --git a/guides/install/electron/index.md b/guides/install/electron/index.md new file mode 100644 index 0000000..794c408 --- /dev/null +++ b/guides/install/electron/index.md @@ -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* diff --git a/img/atom.png b/img/atom.png deleted file mode 100644 index 07df15c..0000000 Binary files a/img/atom.png and /dev/null differ diff --git a/img/electron.svg b/img/electron.svg new file mode 100644 index 0000000..db56b24 --- /dev/null +++ b/img/electron.svg @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/index.md b/index.md index 20bea72..16d7324 100644 --- a/index.md +++ b/index.md @@ -23,11 +23,11 @@ npm install nodegit

Native Shells

- - + + - - Atom + + Electron