mtan93/homebridge
1
0
Fork 0
mirror of https://github.com/mtan93/homebridge.git synced 2026-03-08 21:02:38 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix README

Browse Source
This commit is contained in:
Nick Farina
2015-08-11 22:39:05 -07:00
parent dbedf7fe01
commit 7d6bf73314
1 changed files with 19 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@@ -1,13 +1,13 @@
# Branch in Progress
This branch contains an in-progress ground-up rewrite of HomeBridge that looks more like what we want in the [roadmap](/nfarina/homebridge/wiki/Roadmap).
This branch contains an in-progress ground-up rewrite of Homebridge that looks more like what we want in the [roadmap](/nfarina/homebridge/wiki/Roadmap).
To play with HomeBridge today, follow the instructions in the [master branch](/nfarina/homebridge).
To play with Homebridge today, follow the instructions in the [master branch](/nfarina/homebridge).
## Installing
Install HomeBridge using [npm](https://npmjs.com):
Install Homebridge using [npm](https://npmjs.com):
```sh
npm install -g homebridge
@@ -15,28 +15,32 @@ npm install -g homebridge
## Running
You can run HomeBridge easily from the command line:
You can run Homebridge easily from the command line:
```sh
> homebridge server
> homebridge
```
It will look for any locally-installed plugins and load them up automatically.
Homebridge will automatically load any plugins installed globally from npm.
## Development
To run Homebridge from source, simply execute the `homebridge` script in the `bin` folder:
```sh
> ./bin/homebridge
```
Remember to `npm install` dependencies first!
## Plugins
HomeBridge does nothing by itself; in order to expose your home to HomeKit, you'll need to install one or more HomeBridge "Plugins." A Plugin is an npm module that connects with HomeBridge and registers accessories for devices in your home.
Homebridge does nothing by itself; in order to expose your home to HomeKit, you'll need to install one or more Homebridge Plugins. A Plugin is an npm module that connects with Homebridge and registers "Providers" for devices in your home.
Plugins must be published to npm and tagged with `homebridge-plugin`. The package name must contain the prefix `homebridge-`. For example, a valid package might be `homebridge-lockitron`.
Plugins are automatically discovered and loaded from your home directory inside the `.homebridge` folder. For instance, the Lockitron plugin would be placed here:
Plugins are automatically discovered in your global `node_modules` path. You can add additional plugin search paths via the command line. For example, you can load all plugins in the `example-plugins` folder:
```sh
~/.homebridge/plugins/homebridge-lockitron
> ./bin/homebridge -P example-plugins/
```
Right now you must copy plugins manually (or symlink them from another location). The HomeBridge server will load and validate your Plugin on startup. You can find an example Plugin in [example-plugins/homebridge-lockitron]().
## Running from Source
You can run HomeBridge directly from source by cloning this repo and running the executable [bin/homebridge](). Remember to `npm install` dependencies first!