diff --git a/README.md b/README.md index d2798e5..9a2bcef 100644 --- a/README.md +++ b/README.md @@ -2,4 +2,13 @@ [![Build status](https://badge.buildkite.com/499cf60391b51f08f4050886b0cf04f47f1f2b4461caae16bc.svg)](https://buildkite.com/drjosh9000/plugctl) -Library for controlling Kasa switches +Library for controlling Kasa switches, and a sample app. + +## CLI usage & example + +Assuming your `~/go/bin` is in `$PATH`: + +1. `go get gitea.drjosh.dev/josh/plugctl/cmd/plugctl@latest` +2. `plugctl {on,off,state} --kasa-addr=(host:port)` + +See `cmd/plugctl/main.go` for library usage.