Skip to content

Commit 613c1fc

Browse files
authored
Merge pull request #3 from amimof/release_1.0.2
Updated README for 1.0.2 release
2 parents 3028174 + a06328e commit 613c1fc

File tree

1 file changed

+5
-13
lines changed

1 file changed

+5
-13
lines changed

README.md

Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
[![huego](https://godoc.org/github.com/amimof/huego?status.svg)](https://godoc.org/github.com/amimof/huego)
2-
[![Go Report Card](https://goreportcard.com/badge/github.com/amimof/huego)](https://goreportcard.com/report/github.com/amimof/huego)
3-
[![Coverage](http://gocover.io/_badge/github.com/amimof/huego)](http://gocover.io/github.com/amimof/huego)
1+
[![huego](https://godoc.org/github.com/amimof/huego?status.svg)](https://godoc.org/github.com/amimof/huego) [![Go Report Card](https://goreportcard.com/badge/github.com/amimof/huego)](https://goreportcard.com/report/github.com/amimof/huego) [![Coverage](http://gocover.io/_badge/github.com/amimof/huego)](http://gocover.io/github.com/amimof/huego) [![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/avelino/awesome-go)
42

53
# Huego
64

@@ -10,12 +8,11 @@ An extensive Philips Hue client library for [`Go`](https://golang.org/) with an
108

119

1210
## Installation
13-
Get the package
11+
Get the package and import it in your code.
1412
```
1513
go get github.com/amimof/huego
1614
```
17-
18-
Include it in your code. You may use [`New()`](https://godoc.org/github.com/amimof/huego#New) if you have already created an user and know the IP address to your bridge.
15+
You may use [`New()`](https://godoc.org/github.com/amimof/huego#New) if you have already created an user and know the IP address to your bridge.
1916
```Go
2017
package main
2118

@@ -33,8 +30,7 @@ func main() {
3330
fmt.Printf("Found %d lights", len(l))
3431
}
3532
```
36-
37-
Discover a bridge on your network with [`Discover()`](https://godoc.org/github.com/amimof/huego#Discover) and create a new user with [`CreateUser()`](https://godoc.org/github.com/amimof/huego#Bridge.CreateUser).
33+
Or discover a bridge on your network with [`Discover()`](https://godoc.org/github.com/amimof/huego#Discover) and create a new user with [`CreateUser()`](https://godoc.org/github.com/amimof/huego#Bridge.CreateUser).
3834
```Go
3935
func main() {
4036
bridge, _ := huego.Discover()
@@ -49,10 +45,6 @@ func main() {
4945

5046
See [godoc.org/github.com/amimof/huego](https://godoc.org/github.com/amimof/huego) for the full package documentation.
5147

52-
## Testing
53-
54-
The tests requires an accessible Philips Hue Bridge IP address and a pre-configured username for authenticating. Before running the tests, make sure to set the environment variables `HUE_HOSTNAME` and `HUE_USERNAME`. If you don't have an username, you may create one using [`CreateUser()`](https://godoc.org/github.com/amimof/huego#Bridge.CreateUser) or refer to the official [Getting Started Guide](https://www.developers.meethue.com/documentation/getting-started).
55-
5648
## Contributing
5749

58-
All help in any form is highly appreciated and your are welcome participate in developing `Huego` together. To contribute, clone the `master` branch and create a `Pull Request`. If you want provide feedback, open up a `New Issue` or contact me personally.
50+
All help in any form is highly appreciated and your are welcome participate in developing `Huego` together. To contribute submit a `Pull Request`. If you want to provide feedback, open up a Github `Issue` or contact me personally.

0 commit comments

Comments
 (0)