Skip to content

Commit caf50fe

Browse files
committed
doc: add demo gif to readme
1 parent 8260f05 commit caf50fe

File tree

3 files changed

+14
-3
lines changed

3 files changed

+14
-3
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Groove Sensor
22

3-
![alt text](./img/groove-sensor-logo.svg)
3+
![groove sensor logo](./img/groove-sensor-logo.svg)
44
<p align="center">
5-
<img src="./img/logos.png" alt="sonos-hue" width="400"/>
5+
<img src="./img/logos.png" alt="sonos-hue-spotify" width="400"/>
66
</p>
77

88
![workflow](https://github.com/recursivefunk/groove-sensor/actions/workflows/ci.yml/badge.svg)
@@ -54,6 +54,16 @@ The result should be something like this:
5454
| HUE_MOTION_POLLING_INTERVAL | Number | How long to wait (seconds) in between sensor state polls | No |`2`|
5555
| SONOS_DISCOVERY_TIMEOUT | Number | Timeout (seconds) for the device discovery process | No | `5` |
5656

57+
## Setup and Run
58+
Once you're environment variables are setup
59+
60+
```sh
61+
$ npm install
62+
$ npm start
63+
```
64+
65+
![demo](./img/demo.gif)
66+
5767
### Why Does This Exist?
5868

5969
I have a newly rentovated guest bathroom in my home. The plan is to setup a motion detector and put a sonos speaker in there. When someone enters the bathroom to handle business, they'll hear music based on a "vibe" (most likely hits from the 80s, sorry kids!) I've chosen ahead of time.

img/demo.gif

273 KB
Loading

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
"scripts": {
66
"test": "echo \"Coming soon\" && exit 0",
77
"lint": "semistandard src/**/*.js",
8-
"format": "semistandard --fix src/**/*.js"
8+
"format": "semistandard --fix src/**/*.js",
9+
"start": "node src/index.js"
910
},
1011
"author": "Johnny Austin <[email protected]>",
1112
"license": "MIT",

0 commit comments

Comments
 (0)