diff --git a/README.md b/README.md index 6659006..7511d07 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,17 @@ # LibreMetric -A concept of connected clock. -Built with Wemos D1 Mini and MAX7219. \ No newline at end of file +A simple concept of connected clock. +Built with Wemos D1 Mini and MAX7219. + +# Usage +## Standard usage +Use serial monitor (or your home DHCP server) to know the device's IP. +Connect (with a browser) to the device's webpage. (http:// + +## API usage +You can send messages and change brightness via POST or GET using the root of the included webserver +TODO : Examples + +# Credits +Based on https://github.com/G6EJD/ESP8266-Remote-Message-Board +Modified for my needs \ No newline at end of file