Merge pull request #4 from timrogers/timrogers/cli

feat: add `litra-on` and `litra-off` CLI tools for turning your light on and off

Author: timrogers

README.md

@@ -1,28 +1,36 @@
 # Logitech Litra Glow
 
-This JavaScript library allows you to control your [Logitech Litra Glow](https://www.logitech.com/en-gb/products/lighting/litra-glow.946-000002.html) light programatically.
+This JavaScript driver allows you to control your [Logitech Litra Glow](https://www.logitech.com/en-gb/products/lighting/litra-glow.946-000002.html) light using a CLI and from your JavaScript code.
 
 With this driver, you can:
 
 * Turn your light on and off
 * Set the brightness of your light
 * Set the temperature of your light
 
-## Compatability
+## Compatibility
 
 This library is only tested on macOS Monterey (12.5). It's powered by [`node-hid`](https://github.com/node-hid/node-hid), which is compatible with other macOS versions, Windows and Linux, so it would be expected to work there too, but your milage may vary 🙏
 
-## Installation
+## Using as a command line tool
 
-Simply add the `litra-glow` Node.js package to your `package.json`:
+Make sure you have Node.js available on your machine, and then install the package with `npm install -g litra-glow`.
+
+With the package installed, use the `litra-on` and `litra-off` commands to turn your light on and off.
+
+## Using as a JavaScript library
+
+### Installation
+
+Simply add the `litra-glow` Node.js package to your `package.json` and install it:
 
 ```sh
 npm install --save litra-glow
 ```
 
-## Usage
+### Usage
 
-### Checking if a Litra Glow is plugged in
+#### Checking if a Litra Glow is plugged in
 
 The `findDevice` function checks your computer to find whether a Logitech Litra Glow is plugged in. 
 
@@ -36,7 +44,7 @@ const device = findDevice();
 
 If you're a *huge* fan of the Litra Glow and you have multipled plugged in at the same time, it'll return whatever one it happens to find first.
 
-### Turning your Litra Glow on or off
+#### Turning your Litra Glow on or off
 
 Find your device with `findDevice`, and then use the simple `turnOn` and `turnOff` functions. They just take one parameter: the device.
 
@@ -50,7 +58,7 @@ turnOn(device);
 setTimeout(() => turnOff(device), 5000));
 ```
 
-### Setting the brightness of your Litra Glow
+#### Setting the brightness of your Litra Glow
 
 You can set the brightness of your Litra Glow, measured in Lumen, using the `setBrightnessInLumen` function. The Litra Glow supports brightness between 20 and 250 Lumen:
 
@@ -72,7 +80,7 @@ const device = findDevice();
 setBrightnessPercentage(device, 75);
 ```
 
-### Setting the temperature of your Litra Glow
+#### Setting the temperature of your Litra Glow
 
 You can set the temperature of your Litra Glow, measured in Kelvin, using the `setTemperatureInKelvin` function. The Litra Glow supports temperature between 2700 and 6500 Kelvin:
 

dist/commonjs/cli/litra-off.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

dist/commonjs/cli/litra-off.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const driver_1 = require("./../driver");
+try {
+    const device = (0, driver_1.findDevice)();
+    (0, driver_1.turnOff)(device);
+    process.exit(0);
+}
+catch (e) {
+    console.log(e);
+    process.exit(1);
+}

dist/commonjs/cli/litra-on.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

dist/commonjs/cli/litra-on.js

@@ -0,0 +1,13 @@
+#!/usr/bin/env node
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const driver_1 = require("./../driver");
+try {
+    const device = (0, driver_1.findDevice)();
+    (0, driver_1.turnOn)(device);
+    process.exit(0);
+}
+catch (e) {
+    console.log(e);
+    process.exit(1);
+}

dist/esm/cli/litra-off.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

dist/esm/cli/litra-off.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { findDevice, turnOff } from './../driver';
+try {
+    const device = findDevice();
+    turnOff(device);
+    process.exit(0);
+}
+catch (e) {
+    console.log(e);
+    process.exit(1);
+}

dist/esm/cli/litra-on.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

dist/esm/cli/litra-on.js

@@ -0,0 +1,11 @@
+#!/usr/bin/env node
+import { findDevice, turnOn } from './../driver';
+try {
+    const device = findDevice();
+    turnOn(device);
+    process.exit(0);
+}
+catch (e) {
+    console.log(e);
+    process.exit(1);
+}

package.json

@@ -1,7 +1,7 @@
 {
   "name": "litra-glow",
   "version": "0.0.0-development",
-  "description": "A JavaScript package, including TypeScript types, for programatically controlling your Logitech Litra Glow light",
+  "description": "A driver for controlling your Logitech Litra Glow light from a CLI or your JavaScript code",
   "main": "./dist/commonjs/driver.js",
   "module": "./dist/esm/driver.js",
   "homepage": "https://github.com/timrogers/litra-glow",
@@ -42,5 +42,9 @@
   },
   "release": {
     "branches": ["main"]
+  },
+  "bin": {
+    "litra-on": "./dist/commonjs/cli/litra-on.js",
+    "litra-off": "./dist/commonjs/cli/litra-off.js"
   }
 }