fix: add readme content

package.json

@@ -3,10 +3,9 @@
   "version": "1.0.0",
   "description": "Roku developer helper tools",
   "scripts": {
-    "build": "npm run build:cjs && npm run build:esm && npm run build:umd && npm run build:types",
+    "build": "npm run build:cjs && npm run build:esm && npm run build:types",
     "build:cjs": "node tools/cleanup cjs && tsc -p config/tsconfig.cjs.json --skipLibCheck",
     "build:esm": "node tools/cleanup esm && tsc -p config/tsconfig.esm.json --skipLibCheck",
-    "build:umd": "node tools/cleanup umd && webpack --config config/webpack.config.js",
     "build:types": "node tools/cleanup types && tsc -p config/tsconfig.types.json --skipLibCheck",
     "clean": "node tools/cleanup",
     "lint": "eslint ./",
@@ -18,7 +17,6 @@
   },
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",
-  "umd:main": "dist/umd/index.js",
   "types": "dist/types/index.d.js",
   "keywords": [
     "cli",
@@ -43,23 +41,20 @@
     "form-data": "^4.0.0",
     "fs-extra": "^11.1.1",
     "minimist": "^1.2.8",
-    "uuid": "^9.0.0",
+    "uuid": "^9.0.1",
     "xml2js": "^0.6.2"
   },
   "devDependencies": {
     "@types/form-data": "^2.5.0",
-    "@types/fs-extra": "^11.0.1",
-    "@types/minimist": "^1.2.2",
-    "@types/node": "^20.6.0",
-    "@types/uuid": "^9.0.3",
+    "@types/fs-extra": "^11.0.2",
+    "@types/minimist": "^1.2.3",
+    "@types/node": "^20.8.4",
+    "@types/uuid": "^9.0.5",
     "@types/xml2js": "^0.4.12",
-    "@typescript-eslint/eslint-plugin": "^6.7.0",
-    "@typescript-eslint/parser": "^6.7.0",
-    "eslint": "^8.49.0",
-    "ts-loader": "^9.4.4",
-    "typescript": "^5.2.2",
-    "webpack": "^5.88.2",
-    "webpack-cli": "^5.1.4"
+    "@typescript-eslint/eslint-plugin": "^6.7.5",
+    "@typescript-eslint/parser": "^6.7.5",
+    "eslint": "^8.51.0",
+    "typescript": "^5.2.2"
   },
   "release": {
     "branches": [

src/cli/commands/assets.ts

@@ -4,7 +4,7 @@ import assets from '../../requests/assets';
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Returns current assets saved in memory')
+  return createCommand('Returns a list of the assets that have been loaded into texture memory')
     .option(...getRokuIPOptionDefinition())
     .action(async ({ logger, options }) => {
       const _assets = await assets({

src/cli/commands/beacons.ts

@@ -8,7 +8,7 @@ import { getCommand, getCommandArgumentDefinition } from '../arguments/command';
 type CommandType = 'track' | 'untrack' | 'log';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Command for managing beacons')
+  return createCommand('Tracks channel and media lifecycle events for a specific channel.')
     .argument(...getChannelIdArgumentDefinition())
     .argument(...getCommandArgumentDefinition('Command for beacons', {
       default: 'log',

src/cli/commands/device.ts

@@ -4,7 +4,7 @@ import deviceInfo from '../../requests/deviceInfo';
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Shows data of current Roku Device')
+  return createCommand('Retrieves device information similar to that returned by roDeviceInfo')
     .option(...getRokuIPOptionDefinition())
     .action(async ({ logger, options }) => {
       const device = await deviceInfo({

src/cli/commands/fps.ts

@@ -4,7 +4,7 @@ import graphicsFrameRate from '../../requests/graphicsFrameRate';
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Shows Frames Per Second')
+  return createCommand('Returns the recent number of rendered graphics frames per seconds (this value is separate from the video frame rate).')
     .option(...getRokuIPOptionDefinition())
     .action(async ({ logger, options }) => {
       const fps = await graphicsFrameRate({

src/cli/commands/icon.ts

@@ -6,7 +6,7 @@ import { getPath, getPathArgumentDefinition } from '../arguments/path';
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Downloads an icon for the specific Roku app')
+  return createCommand('Downloads under iconPath an icon file corresponding to the application identified by channelId.')
     .argument(...getChannelIdArgumentDefinition())
     .argument(...getPathArgumentDefinition('Path for Roku app icon .jpg file'))
     .option(...getRokuIPOptionDefinition())

src/cli/commands/key.ts

@@ -18,10 +18,10 @@ const KeyRequest = {
 type KeyType = 'down' | 'press' | 'up';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Send key up/down/press')
+  return createCommand('Sends key press/down/up')
     .argument(...getKeyArgumentDefinition())
     .argument(...getTypeArgumentDefinition('Type of key event - can be: down, up or press', {
-      default: 'down',
+      default: 'press',
       validator: ['down', 'press', 'up'],
     }))
     .option(...getEscapedOptionDefinition())

src/cli/commands/launch.ts

@@ -7,7 +7,7 @@ import { getMediaType, getMediaTypeOptionDefinition } from '../options/mediaType
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Launches Roku App')
+  return createCommand('Launches channel of given channel id with given content id and media type.')
     .argument(...getChannelIdArgumentDefinition())
     .option(...getContentIdOptionDefinition())
     .option(...getMediaTypeOptionDefinition())

src/cli/commands/package.ts

@@ -8,7 +8,7 @@ import { getPassword as getPasswordOption, getPasswordOptionDefinition } from '.
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Generate signed Roku app package')
+  return createCommand('Creates and downloads packaged application.')
     .argument(...getAppNameArgumentDefinition())
     .argument(...getPathArgumentDefinition('Path to the Roku app archive'))
     .argument(...getPasswordArgumentDefinition())

src/cli/commands/performance.ts

@@ -5,7 +5,7 @@ import { getChannelId, getChannelIdArgumentDefinition } from '../arguments/chann
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Shows performance data of active Roku App')
+  return createCommand('Returns the current memory and CPU utilization of the channel running in the foreground (RAM usage is reported bytes).')
     .argument(...getChannelIdArgumentDefinition())
     .option(...getRokuIPOptionDefinition())
     .action(async ({ args, options, logger }) => {

src/cli/commands/player.ts

@@ -4,7 +4,7 @@ import mediaPlayer from '../../requests/mediaPlayer';
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Shows media player data')
+  return createCommand('Returns a child element named \'player\' that identifies the media player state.')
     .option(...getRokuIPOptionDefinition())
     .action(async ({ logger, options }) => {
       const mediaPlayerData = await mediaPlayer({

src/cli/commands/registry.ts

@@ -8,7 +8,7 @@ import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 import { getSections, getSectionsOptionDefinition } from '../options/sections';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Shows registry data')
+  return createCommand('Lists the entries in the device registry for a sideloaded channel or production/beta channel linked to the Roku developer\'s account.')
     .argument(...getChannelIdArgumentDefinition())
     .option(...getEscapedOptionDefinition())
     .option(...getKeysOptionDefinition())

src/cli/commands/rekey.ts

@@ -7,7 +7,7 @@ import { getPassword as getPasswordOption, getPasswordOptionDefinition } from '.
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Rekeys Roku device with provided signed package and password.')
+  return createCommand('Rekey the Roku device with the given signed package and signing password.')
     .argument(...getPasswordArgumentDefinition())
     .argument(...getPathArgumentDefinition('Path to the signed package'))
     .option(...getPasswordOptionDefinition())

src/cli/commands/rendezvous.ts

@@ -8,7 +8,7 @@ import { getCommand, getCommandArgumentDefinition } from '../arguments/command';
 type CommandType = 'track' | 'untrack' | 'log';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Manage rendezvous logging')
+  return createCommand('Lists the node rendezvous events for a sideloaded channel or production/beta channel linked to the Roku developer\'s account.')
     .argument(...getChannelIdArgumentDefinition())
     .argument(...getCommandArgumentDefinition('Command for beacons', {
       default: 'log',

src/cli/commands/upload.ts

@@ -6,7 +6,7 @@ import { getPassword, getPasswordOptionDefinition } from '../options/password';
 import { getRokuIP, getRokuIPOptionDefinition } from '../options/rokuIP';
 
 export default function ({ createCommand }: CreateCommandParameters): Command {
-  return createCommand('Uploads archived app file to the device.')
+  return createCommand('Uploads archived (.zip) app to the Roku device.')
     .argument(...getPathArgumentDefinition('Path to the app archive file'))
     .option(...getPasswordOptionDefinition())
     .option(...getRokuIPOptionDefinition())