Skip to content

Commit c476090

Browse files
authored
Update README.md
1 parent b713cb8 commit c476090

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

README.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@
1010

1111
This is a copy of [ESP8266HTTPUpdateServer](https://github.com/esp8266/Arduino/tree/master/libraries/ESP8266HTTPUpdateServer)/[ESP32's HTTPUpdateServer](https://github.com/espressif/arduino-esp32/tree/master/libraries/HTTPUpdateServer) library, modified to be compatible with [ESPAsyncWebServer](https://github.com/me-no-dev/ESPAsyncWebServer).
1212

13-
It will provide a simple webpage for updating the firmware or filesystem of `ESP8266` or `ESP32` microcontrollers.
13+
It will provide a webpage for updating the firmware/filesystem of `ESP8266` or `ESP32` microcontrollers.
14+
15+
> [!IMPORTANT]
16+
> If you found this library helpful, please consider leaving a Star⭐
17+
>
18+
> It helps a lot in maintaining the project ❤️
1419
1520
## Features
1621
- Supports:
@@ -37,7 +42,7 @@ It will provide a simple webpage for updating the firmware or filesystem of `ESP
3742
This Library is available in `Arduino Library Repository` and `PIO` and you can install it from:
3843
- Arduino IDE Library Manager
3944

40-
<img width="500" src="image.png" alt="arduino library manager"/>
45+
<img width="500" src="image.png" alt="Arduino library manager"/>
4146

4247
- PlatformIO Libraries
4348

@@ -83,25 +88,26 @@ _updateServer.setup(&_server, "/customroute", "username", "password");
8388
<img width="500" src="image-3.png" alt="Minimal OTA Page"/>
8489

8590
> [!IMPORTANT]
86-
> By default styling is disabled in order to save ~350 bytes of flash memory.
91+
> By default styling is disabled to save ~350 bytes of flash memory.
8792
>
88-
> you can enable the styling by adding the `-DESPASYNCHTTPUPDATESERVER_PRETTY` Build Flag to your environment.
93+
> You can enable the styling by adding the `-DESPASYNCHTTPUPDATESERVER_PRETTY` Build Flag to your environment.
8994
9095
### Selecting FileSystem
9196
> [!IMPORTANT]
9297
> The library's default fileSystem is `SPIFFS` but if you are using `LittleFS` for your FileSystem, make sure to add the `-DESPASYNCHTTPUPDATESERVER_LITTLEFS` Build Flag to your environment.
9398
9499
### Debugging
95100
> [!TIP]
96-
> In order to debug the library functionality, you can add the `-DESPASYNCHTTPUPDATESERVER_DEBUG` Build Flag to your environment.
101+
> To debug the library functionality, you can add the `-DESPASYNCHTTPUPDATESERVER_DEBUG` Build Flag to your environment.
97102
>
98103
> This will enable the library to print logs to the Serial.
99104
100105
> [!TIP]
101106
> If you are using another `Serial` port, you can override the default serial by adding the `-DESPASYNCHTTPUPDATESERVER_SerialOutput=Serial1` Build Flag to your environment.
102107
103108
## TODO:
104-
- custom css support
109+
- Custom CSS support
110+
- Synchronous WebServer support
105111

106112
## Contribution
107113
- You can open Issues for any bug report or feature request.

0 commit comments

Comments
 (0)