From 0e9d237d03f58875c400c2fff4474345398d144e Mon Sep 17 00:00:00 2001 From: Nick Farina Date: Tue, 7 Jul 2015 19:40:14 -0700 Subject: [PATCH] Unify example accessory Using Lockitron for first new-style example accessory, since it has a very simple and public API. --- README.md | 8 ++++---- example-providers/homebridge-liftmaster/index.js | 3 --- example-providers/homebridge-lockitron/index.js | 3 +++ .../package.json | 4 ++-- 4 files changed, 9 insertions(+), 9 deletions(-) delete mode 100644 example-providers/homebridge-liftmaster/index.js create mode 100644 example-providers/homebridge-lockitron/index.js rename example-providers/{homebridge-liftmaster => homebridge-lockitron}/package.json (60%) diff --git a/README.md b/README.md index bcb94e3..c3ba1eb 100644 --- a/README.md +++ b/README.md @@ -27,15 +27,15 @@ It will look for any locally-installed providers and load them up automatically. HomeBridge does nothing by itself; in order to expose your home to HomeKit, you'll need to install one or more HomeBridge "Providers." A Provider is an npm module that connects with HomeBridge and registers accessories for devices in your home. -Providers must be published to npm and tagged with `homebridge-provider`. The package name must contain the prefix `homebridge-`. For example, a valid package might be `homebridge-philips-hue`. +Providers must be published to npm and tagged with `homebridge-provider`. The package name must contain the prefix `homebridge-`. For example, a valid package might be `homebridge-lockitron`. -Providers are automatically discovered and loaded from your home directory inside the `.homebridge` folder. For instance, the Philips Hue Provider would be placed here: +Providers are automatically discovered and loaded from your home directory inside the `.homebridge` folder. For instance, the Lockitron provider would be placed here: ```sh -~/.homebridge/providers/node_modules/homebridge-philips-hue +~/.homebridge/providers/node_modules/homebridge-lockitron ``` -Right now you must copy providers manually (or symlink them from another location). The HomeBridge server will load and validate your Provider on startup. You can find an example Provider stub in [example-providers/homebridge-liftmaster](). +Right now you must copy providers manually (or symlink them from another location). The HomeBridge server will load and validate your Provider on startup. You can find an example Provider stub in [example-providers/homebridge-lockitron](). ## Running from Source diff --git a/example-providers/homebridge-liftmaster/index.js b/example-providers/homebridge-liftmaster/index.js deleted file mode 100644 index 9b67bad..0000000 --- a/example-providers/homebridge-liftmaster/index.js +++ /dev/null @@ -1,3 +0,0 @@ - -// Demonstrate that we were loaded -console.log("LiftMaster provider loaded!"); diff --git a/example-providers/homebridge-lockitron/index.js b/example-providers/homebridge-lockitron/index.js new file mode 100644 index 0000000..e9a5dfd --- /dev/null +++ b/example-providers/homebridge-lockitron/index.js @@ -0,0 +1,3 @@ + +// Demonstrate that we were loaded +console.log("Lockitron provider loaded!"); diff --git a/example-providers/homebridge-liftmaster/package.json b/example-providers/homebridge-lockitron/package.json similarity index 60% rename from example-providers/homebridge-liftmaster/package.json rename to example-providers/homebridge-lockitron/package.json index 1c85295..2e16cf3 100644 --- a/example-providers/homebridge-liftmaster/package.json +++ b/example-providers/homebridge-lockitron/package.json @@ -1,7 +1,7 @@ { - "name": "homebridge-liftmaster", + "name": "homebridge-lockitron", "version": "0.0.0", - "description": "LiftMaster Support for HomeBridge", + "description": "Lockitron Support for HomeBridge", "license": "ISC", "engines": { "homebridge": ">=0.0.0"