diff --git a/README.md b/README.md index 8b13789..dd36ace 100644 --- a/README.md +++ b/README.md @@ -1 +1,17 @@ +# Kindle Dashboard +*Using a Kindle 4 to display weather and train times* + +--- + +This is the image generation code and runtime scripts for my Kindle dashboard that I keep on my nightstand. + +![example system](example-image.png) + +Much of the Kindle-specific work here was done by [David Hamp-Gonsalves](https://github.com/davidhampgonsalves/Life-Dashboard) and modified a little by myself, as was the general SSR'd image-based architecture. However, the image generation code is my own and was built from scratch using the [Met Office DataPoint API](https://www.metoffice.gov.uk/services/data/datapoint) and the [RealtimeTrains pull API](https://www.realtimetrains.co.uk/about/developer/pull/docs/). + +The image generation code is an importable Go library within the `imagegen` directory. + +## The Kindle + +This project runs on a jailbroken Kindle 4 with a couple of additional packages on top. More detail coming soon, but broadly speaking it has the same runtime dependencies as David's version. diff --git a/example-image.png b/example-image.png new file mode 100644 index 0000000..517ff9d Binary files /dev/null and b/example-image.png differ