Skip to content

Commit

Permalink
Doc updates
Browse files Browse the repository at this point in the history
  • Loading branch information
lorenwest committed Sep 1, 2017
1 parent 60f80ef commit 3169f37
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ Congratulations, you've got a running Homie device!

Take a look at the messages on your MQTT bus under devices/bare-minimum. Then ctrl-c the program and watch the broker administer the will.

Setting Firmware
----------------

To publish the firmware name & version, call `myDevice.setFirmware()`:

```
var HomieDevice = require('homie-device');
var myDevice = new HomieDevice('bare-minimum');
myDevice.setFirmware('nodejs-test', '0.0.1');
myDevice.setup();
```

Adding a Node
-------------

Expand Down Expand Up @@ -202,7 +214,7 @@ myDevice.setup(true);

Contributors
------------
<table id="contributors"><tr><td><img width="124" src="https://avatars2.githubusercontent.com/u/373538?v=4"><br/><center><a href="https://github.com/lorenwest">lorenwest</a></center></td></tr></table>
<table id="contributors"><tr><td><img width="124" src="https://avatars2.githubusercontent.com/u/373538?v=4"><br/><a href="https://github.com/lorenwest">lorenwest</a></td></tr></table>

License
-------
Expand Down
2 changes: 1 addition & 1 deletion bin/contributors.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ _.templateSettings = {
};
var TABLE_TEMPLATE = _.template('<table id="contributors">{{rows}}</table>');
var ROW_TEMPLATE = _.template('<tr>{{people}}</tr>');
var PERSON_TEMPLATE = _.template('<td><img width="124" src="{{avatar_url}}"><br/><center><a href="{{html_url}}">{{login}}</a></center></td>');
var PERSON_TEMPLATE = _.template('<td><img width="124" src="{{avatar_url}}"><br/><a href="{{html_url}}">{{login}}</a></td>');
var PEOPLE_PER_ROW = 6;

// Read the contributor list from github, return as an HTML table
Expand Down

0 comments on commit 3169f37

Please sign in to comment.