Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
Signed-off-by: Mike Kaperys <[email protected]>
  • Loading branch information
Mike Kaperys committed Jul 24, 2018
1 parent dea2bcd commit 7d92780
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Go WebOS
# Go WebOS 📺

A small Go library for controlling WebOS TVs. Tested on LG webOS TV UH668V (webOS version 05.30.20).
A small Go library for interaction with webOS enabled TVs. Tested on LG webOS TV UH668V (webOS version 05.30.20).

```go
dialer := websocket.Dialer{
Expand All @@ -10,9 +10,9 @@ dialer := websocket.Dialer{
NetDial: (&net.Dialer{Timeout: time.Second * 5}).Dial,
}

tv, err := webos.NewTV(&dialer, "192.168.1.67")
tv, err := webos.NewTV(&dialer, "<tv-ipv4-address>")
if err != nil {
log.Fatalf("could not dial: %v", err)
log.Fatalf("could not dial TV: %v", err)
}
defer tv.Close()

Expand All @@ -29,9 +29,10 @@ if err != nil {
// AuthoriseClientKey(<key>) method, instead of AuthorisePrompt()
fmt.Println("Client Key:", key)

// see commands.go for available methods
tv.Notification("📺👌")
```

See [examples](examples/) for usage.

Inspired by [lgtv.js](https://github.com/msloth/lgtv.js), [go-lgtv](https://github.com/dhickie/go-lgtv) and [webostv](https://github.com/snabb/webostv).
🌟 Inspired by [lgtv.js](https://github.com/msloth/lgtv.js), [go-lgtv](https://github.com/dhickie/go-lgtv) and [webostv](https://github.com/snabb/webostv).

0 comments on commit 7d92780

Please sign in to comment.