diff --git a/README.md b/README.md index dbe5bc7..926addd 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,11 @@ -woodhouse-hangouts +Woodhouse Google Hangouts Interface ================== +This module allows you to contact Woodhouse using Google Hangouts. It is advised that you create a seperate hangouts address for Woodhouse to log in with. + +## Installation + +* Clone the this repo into the interfaces directory. +* `npm install` within the cloned directory +* If Woodhouse isn't already started, start it and skip to the last step +* If you have the shell interface enabled (enabled by default), run `load modules`, otherwise restart Woodhouse +* Go to [http://localhost:8080](http://localhost:8080), navigate to the interface page and select the Hangouts interface. Fill in the login details for the bot, check the enabled box and click save.