From 9b42fafdaf9c9d2d3c344215bdfe06849b8c10e0 Mon Sep 17 00:00:00 2001 From: Nick Farina Date: Mon, 7 Mar 2016 11:49:13 -0800 Subject: [PATCH] Add README example for plugin development --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index c1d3462..9f8fa7b 100644 --- a/README.md +++ b/README.md @@ -111,6 +111,16 @@ And you can find an example plugin that publishes an individual accessory at [he See more examples on how to create Platform classes in the [Legacy Plugins](https://github.com/nfarina/homebridge-legacy-plugins/tree/master/platforms) repository. +# Plugin Development + +When writing your plugin, you'll want Homebridge to load it from your development directory instead of publishing it to `npm` each time. You can tell Homebridge to look for your plugin at a specific location using the command-line parameter `-P`. For example, if you are in the Homebridge directory (as checked out from Github), you might type: + +```sh +DEBUG=* ./bin/homebridge -D -P ../my-great-plugin/ +``` + +This will start up Homebridge and load your in-development plugin from a nearby directory. + # Common Issues ### My iOS App Can't Find Homebridge