Commit 1e3b07c503bbcba6c4efb83272b179de19eb70cf
Committed by
Moritz Wirger
1 parent
6b673cb4
Incorporate build and install as well as testing into readme
Showing
1 changed file
with
3 additions
and
3 deletions
README.md
| @@ -12,8 +12,8 @@ A simple and easy to use library for Philips Hue Lights | @@ -12,8 +12,8 @@ A simple and easy to use library for Philips Hue Lights | ||
| 12 | ## How to use | 12 | ## How to use |
| 13 | ### <a name="searchingBridges"></a>Searching for Bridges | 13 | ### <a name="searchingBridges"></a>Searching for Bridges |
| 14 | To start searching for a Hue Bridge you will need to choose an IHttpHandler and create one. For now there is only one, the "HttpHandler". | 14 | To start searching for a Hue Bridge you will need to choose an IHttpHandler and create one. For now there is only one, the "HttpHandler". |
| 15 | -Then create a HueFinder object with the handler. | ||
| 16 | -The handler is needed, because it tells the finder which functions to use to communicate with a bridge or your local network. | 15 | +Then create a HueFinder object with the handler. |
| 16 | +The handler is needed, because it tells the finder which functions to use to communicate with a bridge or your local network. | ||
| 17 | After that you can call FindBridges(), which will return a vector containing the ip and mac address of all found Bridges. | 17 | After that you can call FindBridges(), which will return a vector containing the ip and mac address of all found Bridges. |
| 18 | If no Bridges were found the vector is empty, so make sure that in that case you provide an ip and mac address. | 18 | If no Bridges were found the vector is empty, so make sure that in that case you provide an ip and mac address. |
| 19 | ```C++ | 19 | ```C++ |
| @@ -38,7 +38,7 @@ If you on the other hand already have a username you can add your bridge like so | @@ -38,7 +38,7 @@ If you on the other hand already have a username you can add your bridge like so | ||
| 38 | finder.AddUsername(bridges[0].mac, "<username>"); | 38 | finder.AddUsername(bridges[0].mac, "<username>"); |
| 39 | Hue bridge = finder.GetBridge(bridges[0]); | 39 | Hue bridge = finder.GetBridge(bridges[0]); |
| 40 | ``` | 40 | ``` |
| 41 | -If you do not want to use the HueFinder or you already know the ip and username of your bridge you have the option to create your own Hue object. | 41 | +If you do not want to use the HueFinder or you already know the ip and username of your bridge you have the option to create your own Hue object. |
| 42 | Here you will need to provide the ip address, a username and an HttpHandler | 42 | Here you will need to provide the ip address, a username and an HttpHandler |
| 43 | ```C++ | 43 | ```C++ |
| 44 | handler = std::make_shared<HttpHandler>(); | 44 | handler = std::make_shared<HttpHandler>(); |