From 1006640dadea8f05979bc76a2dfc0b422ec2f694 Mon Sep 17 00:00:00 2001 From: Brian Ingenito <28159742+bingenito@users.noreply.github.com> Date: Mon, 8 Apr 2019 15:53:05 -0400 Subject: [PATCH] Fix missed readme updates from lerna monorepo refactor (#234) - Documentation links in main readme - Missing includes in Electron example Fixes #233 --- README.md | 4 ++-- examples/electron/README.md | 5 +++-- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a8495a8c..6a5ad9f7 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ container agnostic and provide portability when multiple container deployments a Usage --------------- -The first step is to simply [resolve](https://morgan-stanley.github.io/desktopJS/modules/_registry_.html#resolvecontainer) the current [container](https://morgan-stanley.github.io/desktopJS/classes/_container_.container.html). This enumerates +The first step is to simply [resolve](https://morgan-stanley.github.io/desktopJS/modules/_morgan_stanley_desktopjs.html#resolvecontainer) the current [container](https://morgan-stanley.github.io/desktopJS/classes/_morgan_stanley_desktopjs.container.html). This enumerates all registered containers (including your own custom container or derived custom implementations) and returns the container implementation that matches. @@ -26,7 +26,7 @@ var container = desktopJS.resolveContainer(); console.log("Container: " + container.hostType); ``` -Interact with the [container](https://morgan-stanley.github.io/desktopJS/classes/_container_.container.html) via a single api instead of having conditional code or applications +Interact with the [container](https://morgan-stanley.github.io/desktopJS/classes/_morgan_stanley_desktopjs.container.html) via a single api instead of having conditional code or applications based on deployment. ``` diff --git a/examples/electron/README.md b/examples/electron/README.md index fa376dbb..fe0bfeb9 100644 --- a/examples/electron/README.md +++ b/examples/electron/README.md @@ -19,8 +19,8 @@ node process. From your bootstrap, use the same consistent api as you would from your application. ``` -const desktopJS = require('desktopjs'); -const electron = require('electron'); +const desktopJS = require('@morgan-stanley/desktopjs'); +const djsElectron = require('@morgan-stanley/desktopjs-electron'); const app = electron.app; let mainWindow; @@ -41,6 +41,7 @@ index.html +