diff --git a/README.md b/README.md index 2acbb1c..40612b4 100644 --- a/README.md +++ b/README.md @@ -53,16 +53,16 @@ Apply the [Arduino core](https://github.com/esp8266/Arduino) of the ESP8266 Comm Most simple approach to applying AutoConnect for the existing sketches, follow the below steps. - + ## More usages and Documentation -The documentation is available on https://Hieromon.github.io/AutoConnect, here are some shortcuts: +Full documentation is available on https://Hieromon.github.io/AutoConnect, some quick links at the list: -- [Installation](https://hieromon.github.io/AutoConnect/index.html#installation). -- [Getting started](https://hieromon.github.io/AutoConnect/gettingstarted/index.html). -- [Usage the Library](https://hieromon.github.io/AutoConnect/usage/index.html). -- [API reference](https://hieromon.github.io/AutoConnect/api/index.html). +- The [Installation](https://hieromon.github.io/AutoConnect/index.html#installation) is the installation procedure and requirements for the library. +- [Getting started](https://hieromon.github.io/AutoConnect/gettingstarted/index.html) with the most simple sketch for using AutoConnect. +- The [Usage the Library](https://hieromon.github.io/AutoConnect/usage/index.html) quides to using the library correctly. +- The [API reference](https://hieromon.github.io/AutoConnect/api/index.html) describes the AutoConnect functions specification. - [FAQ](https://hieromon.github.io/AutoConnect/faq/index.html). ## License diff --git a/mkdocs/images/BeforeAfter.svg b/mkdocs/images/BeforeAfter.svg index 7fbdce7..021e318 100644 --- a/mkdocs/images/BeforeAfter.svg +++ b/mkdocs/images/BeforeAfter.svg @@ -8,9 +8,9 @@ xmlns="http://www.w3.org/2000/svg" id="svg8" version="1.1" - viewBox="0 0 278.12582 198.967" - height="198.967mm" - width="278.12582mm"> + viewBox="0 0 196.63957 182.99508" + height="182.99507mm" + width="196.63957mm"> - - - #include <ESP8266WiFi.h>#include <ESP8266WebServer.h> + + + #include <ESP8266WiFi.h>#include <ESP8266WebServer.h>ESP8266WebServer Server;void rootPage() { char content[] = "Hello, world"; Server. Server.send(200, "text/plain", content);}}void setup() { delay(1000); Serial.begin(115200); Serial.println(); WiFi.begin("ssid", "pass"); while (WiFi.status() != WL_CONNECTED) { WiFi.status() != WL_CONNECTED) { delay(100); } Server. } Server.on("/", rootPage); Server. Server.begin(); Serial.println("WiFi connected: " + WiFi.localIP().toString());}"Web server started:" + WiFi.localIP().toString());}void loop() { Server. Server.handleClient();} - #include <ESP8266WiFi.h>#include <ESP8266WebServer.h>#include <AutoConnect.h>} + #include <ESP8266WiFi.h>#include <ESP8266WebServer.h>#include <AutoConnect.h>ESP8266WebServer Server;AutoConnect Portal(Server);void rootPage() { void rootPage() { char content[] = "Hello, world"; Server. Server.send(200, "text/plain", content);}}void setup() { delay(1000); Serial.begin(115200); Serial.println(); Server. Server.on("/", rootPage); boolean r = Portal. Portal.begin(); if (r) { Serial.println("WiFi connected: " + WiFi.localIP().toString()); }}"Web server started:" + WiFi.localIP().toString());}void loop() { Portal. Portal.handleClient();} - Before - Insert - Insert - - - - - Remove - - - - Replace - - - - - - - Replace - - - - - After - + style="font-size:3.17499995px;line-height:0" + y="217.19405" + x="-77.797623" + id="tspan2028">} + Before + Insert + Insert + + + + + Remove + + + + Replace + + + + + Replace + + + After + + diff --git a/mkdocs/images/beforeafter.png b/mkdocs/images/beforeafter.png new file mode 100644 index 0000000..c256c5d Binary files /dev/null and b/mkdocs/images/beforeafter.png differ