diff options
| author | bndw <benjamindwoodward@gmail.com> | 2020-05-31 09:14:00 -0700 |
|---|---|---|
| committer | bndw <benjamindwoodward@gmail.com> | 2020-05-31 09:26:17 -0700 |
| commit | 4c23f82cc4f1dd25de6376ee45a7668fc2ca0e15 (patch) | |
| tree | 74d05f5988d5fd4d81356748d65882cf4cde8a46 /README.md | |
| parent | 6371e7794d2fa9ba5b79f267219e50e885057342 (diff) | |
:lipstick: Update readme
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 15 |
1 files changed, 13 insertions, 2 deletions
| @@ -2,11 +2,22 @@ | |||
| 2 | 2 | ||
| 3 | # WiFi Card | 3 | # WiFi Card |
| 4 | 4 | ||
| 5 | Print your WiFi info on a neat little card and stick it on the fridge. | 5 | Print a neat little card with your WiFi info and stick it on the fridge. |
| 6 | Use the QR code to connect phones. | 6 | |
| 7 | It looks like this: | ||
| 8 | |||
| 9 | <img width=400 src="https://user-images.githubusercontent.com/4248167/83356910-05361c00-a31e-11ea-8735-95852b82ddcf.png"> | ||
| 7 | 10 | ||
| 8 | ## Running locally | 11 | ## Running locally |
| 9 | 12 | ||
| 13 | Run the latest Docker image on http://localhost:8080 | ||
| 14 | |||
| 15 | ``` | ||
| 16 | docker run --rm -p 8080:80 bndw/wifi-card:latest | ||
| 17 | ``` | ||
| 18 | |||
| 19 | Or run the live-reload server on http://localhost:8080 | ||
| 20 | |||
| 10 | ``` | 21 | ``` |
| 11 | make dev | 22 | make dev |
| 12 | ``` | 23 | ``` |