From df89537688bfc9609d87584024cdc7bb1e768677 Mon Sep 17 00:00:00 2001 From: The Jared Wilcurt <4629794+TheJaredWilcurt@users.noreply.github.com> Date: Sat, 5 Sep 2020 11:56:24 -0400 Subject: [PATCH] Update docs --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index a45b375..10bd9e8 100644 --- a/README.md +++ b/README.md @@ -16,11 +16,17 @@ const app = require('nw-electron-adapter')(window); // and have most of the API work the same in NW.js. ``` -## API Reference -* https://www.electronjs.org/docs/api/app +## Usage + +1. `npm install --save nw-electron-adapter` +1. Replace `const app = require('electron').app;` or `const {app} = require('electron');` with `const app = require('nw-electron-adapter')(window);` +1. Reference the below API Parity Tracker and make issues/PR's for missing features you need. + -## Parity Tracker +## API Parity Tracker + +* https://www.electronjs.org/docs/api/app **Statuses:** @@ -44,8 +50,8 @@ const app = require('nw-electron-adapter')(window); [`hide`](src/api/hide.js) | 🌕🌑🌑🌑 | Planned [`show`](src/api/show.js) | 🌕🌑🌑🌑 | Planned [`setAppLogsPath`](src/api/setAppLogsPath.js) | 🌑🌑🌑🌑 | Not Planned -[`getAppPath`](src/api/getAppPath.js) | 🌕🌕🌕🌗 | Tested -[`getPath`](src/api/getPath.js) | 🌕🌕🌕🌗 | Tested +[`getAppPath`](src/api/getAppPath.js) | 🌕🌕🌕🌕 | Released v1.0.0 +[`getPath`](src/api/getPath.js) | 🌕🌕🌕🌕 | Released v1.0.0 [`getFileIcon`](src/api/getFileIcon.js) | 🌑🌑🌑🌑 | Not Planned [`setPath`](src/api/setPath.js) | 🌑🌑🌑🌑 | Not Planned [`getVersion`](src/api/getVersion.js) | 🌑🌑🌑🌑 | Not Planned