Merge pull request #35 from open-olive/examples-update

update NodeJS examples to include relevant command

Author: bbrewer-oliveai

ldk/node/examples/clipboard/package.json

@@ -4,6 +4,7 @@
   "description": "",
   "main": "src/index.ts",
   "scripts": {
+    "build": "rm -rf dist && tsc",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",

ldk/node/examples/clipboard/readme.md

@@ -0,0 +1,33 @@
+## Clipboard LDK Usage Example
+This NodeJS module utilizes the OliveHelps NodeJS LDK to demonstrate listening for clipboard events and sending them to the OliveHelps UI as Whispers.
+
+### Modifying
+The Loop itself is defined in `src/index.ts`
+
+Install dependencies
+```shell
+npm install
+```
+
+Modify `src/index.ts` as desired.
+
+### Running Locally
+
+#### Local Plugin Command (Recommended)
+
+Olive Helps lets you add a local command as a Local Loop:
+
+1. Open Olive Helps.
+2. Open the Loop Library:
+    1. Click the Hamburger icon.
+    2. Click Loop Library.
+3. Click the "Install Local Loop" button:
+4. Select the working directory for the Loop (the directory this README is in).
+5. Enter the command to be executed, including any arguments. For this example the command will be `./node_modules/.bin/ts-node src/index.ts`
+6. Click Install.
+
+The command will be installed as a Loop. If you need to change the command or its arguments you'll need remove it and then add the new commands.
+
+Otherwise, if you instead want to make changes to the Loop itself, you can:
+- Modify `src/index.ts`
+- Restart OliveHelps

ldk/node/examples/network/readme.md

@@ -0,0 +1,33 @@
+## Network LDK Usage Example
+This NodeJS module utilizes the OliveHelps NodeJS LDK to demonstrate the usage of the Network sensor
+
+### Modifying
+The Loop itself is defined in `src/index.ts`
+
+Install dependencies
+```shell
+npm install
+```
+
+Modify `src/index.ts` as desired.
+
+### Running Locally
+
+#### Local Plugin Command (Recommended)
+
+Olive Helps lets you add a local command as a Local Loop:
+
+1. Open Olive Helps.
+2. Open the Loop Library:
+   1. Click the Hamburger icon.
+   2. Click Loop Library.
+3. Click the "Install Local Loop" button:
+4. Select the working directory for the Loop (the directory this README is in).
+5. Enter the command to be executed, including any arguments. For this example the command will be `./node_modules/.bin/ts-node src/index.ts`
+6. Click Install.
+
+The command will be installed as a Loop. If you need to change the command or its arguments you'll need remove it and then add the new commands.
+
+Otherwise, if you instead want to make changes to the Loop itself, you can:
+- Modify `src/index.ts`
+- Restart OliveHelps

ldk/node/examples/whisper-disambiguation/readme.md

@@ -0,0 +1,33 @@
+## Whisper Disambiguation LDK Usage Example
+This NodeJS module utilizes the OliveHelps NodeJS LDK to demonstrate the usage of Whisper Disambiguation.
+
+### Modifying
+The Loop itself is defined in `src/index.ts`
+
+Install dependencies
+```shell
+npm install
+```
+
+Modify `src/index.ts` as desired.
+
+### Running Locally
+
+#### Local Plugin Command (Recommended)
+
+Olive Helps lets you add a local command as a Local Loop:
+
+1. Open Olive Helps.
+2. Open the Loop Library:
+   1. Click the Hamburger icon.
+   2. Click Loop Library.
+3. Click the "Install Local Loop" button:
+4. Select the working directory for the Loop (the directory this README is in).
+5. Enter the command to be executed, including any arguments. For this example the command will be `./node_modules/.bin/ts-node src/index.ts`
+6. Click Install.
+
+The command will be installed as a Loop. If you need to change the command or its arguments you'll need remove it and then add the new commands.
+
+Otherwise, if you instead want to make changes to the Loop itself, you can:
+- Modify `src/index.ts`
+- Restart OliveHelps

ldk/node/examples/whisper-list/readme.md

@@ -0,0 +1,33 @@
+## Whisper List LDK Usage Example
+This NodeJS module utilizes the OliveHelps NodeJS LDK to demonstrate the different types of formatting and options available in Loop Whispers.
+
+### Modifying
+The Loop itself is defined in `src/index.ts`
+
+Install dependencies
+```shell
+npm install
+```
+
+Modify `src/index.ts` as desired.
+
+### Running Locally
+
+#### Local Plugin Command (Recommended)
+
+Olive Helps lets you add a local command as a Local Loop:
+
+1. Open Olive Helps.
+2. Open the Loop Library:
+   1. Click the Hamburger icon.
+   2. Click Loop Library.
+3. Click the "Install Local Loop" button:
+4. Select the working directory for the Loop (the directory this README is in).
+5. Enter the command to be executed, including any arguments. For this example the command will be `./node_modules/.bin/ts-node src/index.ts`
+6. Click Install.
+
+The command will be installed as a Loop. If you need to change the command or its arguments you'll need remove it and then add the new commands.
+
+Otherwise, if you instead want to make changes to the Loop itself, you can:
+- Modify `src/index.ts`
+- Restart OliveHelps