From 64b98ee5adb7326e1ee65fb3750e143db3987043 Mon Sep 17 00:00:00 2001 From: Jonny Bergdahl Date: Tue, 21 Nov 2023 22:16:44 +0100 Subject: [PATCH] Add link to documentation --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5bbd3ce..c6c37a7 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,11 @@ that you can also use as a starting point for your own firmware. - `FIRMWARE_VARIANT_MQTT` - Use the WiFiManager, web configuration portal and MQTT support - `FIRMWARE_VARIANT_HA` - Use the WiFiManager, web configuration portal, MQTT and Home Assistant support -### Basic JBWoprDevice usage +### Code documentation + +Full code documentation is available at https://jonnybergdahl.github.io/jbwopr/ + +## JBWoprDevicee Create an instance of the `JBWoprDevice` class. Do any configuration you need to do then and call `begin()` in your `setup()` function. Then call `loop()` in your `loop()` function.