aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorCollin Guarino <Collinux@users.noreply.github.com>2016-02-18 16:20:42 -0500
committerCollin Guarino <Collinux@users.noreply.github.com>2016-02-18 16:20:42 -0500
commit851d78cc8d9c948f77da9623841b6a3dfad1dd5a (patch)
treec0f1b0d8c45fdf7fc151cdf860820fe17515fcc0 /README.md
parent4715205f959490a55b8a2ad8aef56ce503709dbb (diff)
Added installation and usage sections.
Diffstat (limited to 'README.md')
-rw-r--r--README.md23
1 files changed, 17 insertions, 6 deletions
diff --git a/README.md b/README.md
index 949784e..d530bd3 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,17 @@
# GoHue
Package hue interfaces Philips Hue devices to control lights, scenes, schedules, and groups.
-## License
-Copyright (C) 2016 Collin Guarino (Collinux)
-GPL version 2 or higher http://www.gnu.org/licenses/gpl.html
-GoHue project maintained by Collin Guarino, collin.guarino@gmail.com
+## Installation
+```
+go get github.com/collinux/gohue
+```
-## Contributing
-Pull requests happily accepted on GitHub
+## Usage
+```
+import "github.com/collinux/gohue"
+EXAMPLES COMING SOON
+```
## Features
##### Lights
@@ -76,3 +79,11 @@ Pull requests happily accepted on GitHub
## API Documentation
For official Philips Hue documentation check out the [Philips website](http://www.developers.meethue.com/philips-hue-api)
+
+## License
+Copyright (C) 2016 Collin Guarino (Collinux)
+GPL version 2 or higher http://www.gnu.org/licenses/gpl.html
+GoHue project maintained by Collin Guarino, collin.guarino@gmail.com
+
+## Contributing
+Pull requests happily accepted on GitHub