Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

Commit

Permalink
fix(docs): add new api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ThorstenHans committed Jan 10, 2019
1 parent 81c011e commit 500803b
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@

Checkout the introduction post on my [blog](https://medium.com/@ThorstenHans/integrating-angular-and-electron-using-ngx-electron-9c36affca25e#.4scol1nli) for more details.

## Support me

[![Become a Patron!](https://c5.patreon.com/external/logo/become_a_patron_button.png)](https://www.patreon.com/bePatron?u=16380186)

## Installation

`ngx-electron` can be installed easily using either `yarn` or `npm` commands in the scope of an angular project.
Expand Down Expand Up @@ -84,3 +88,8 @@ The `ElectronService` is exposing all API's accessible from within Electron's re
* `shell: Electron.Shell` - Electron's Shell API
* `nativeImage: Electron.NativeImage` - Electron's NativeImage API
* `isElectronApp: boolean` - Indicates if app is being executed inside of electron or not
* `isMacOS: boolean` - Indicates if app is running in electron and on `macOS`
* `isWindows: boolean` - Indicates if app is running in electron and on `Windows`
* `isLinux: boolean` - Indicates if app is running in electron and on `Linux`
* `isX86: boolean` - Indicates if app is running in electron and on a `x86` architecture
* `isX64: boolean` - Indicates if app is running in electron and on a `x64` architecture

0 comments on commit 500803b

Please sign in to comment.