Skip to content

Commit ba4a4cb

Browse files
committed
update readme
1 parent 914313c commit ba4a4cb

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ A simple library to add support for Over-The-Air (OTA) updates to your project.
1313

1414
## Features
1515

16+
- [x] Zlib or gzip compressed firmware support
1617
- [x] Web update (requires web server)
1718
- [x] Batch firmware sync
1819
- [x] Force firmware update [#8]
@@ -34,7 +35,7 @@ There are a few things that need to be in place for an update to work.
3435
- A webserver with the firmware information in a JSON file
3536
- Firmware version
3637
- Firmware type
37-
- Firmware bin
38+
- Firmware bin (can optionnally be compressed with zlib or gzip)
3839
- For https or signature check: SPIFFS with root_ca.pem (https) and rsa_key.pem (signature check)
3940

4041
You can supply http or https URLs. If you are using https, you need the root_ca.pem in your SPIFFS partition. For the actual firmware it will use https when you define port 443 or 4433. Otherwise it will use plain http.
@@ -190,8 +191,8 @@ void loop()
190191
Late init is possible using `FOTAConfig_t`, allowing more complex configurations:
191192
192193
```cpp
194+
#include <SPIFFS.h> // include filesystem *before* esp32FOTA librart
193195
#include <esp32FOTA.hpp>
194-
#include <SPIFFS.h>
195196
196197
esp32FOTA FOTA;
197198

0 commit comments

Comments
 (0)