Skip to content
This repository was archived by the owner on Feb 4, 2023. It is now read-only.

Commit 381ca3a

Browse files
authored
v1.0.6+
Enhance README.md
1 parent b1c9f04 commit 381ca3a

File tree

1 file changed

+23
-12
lines changed

1 file changed

+23
-12
lines changed

README.md

Lines changed: 23 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@
22

33
[![arduino-library-badge](https://www.ardu-badge.com/badge/ESP_WiFiManager.svg?)](https://www.ardu-badge.com/ESP_WiFiManager)
44

5+
### Releases 1.0.6
6+
7+
1. Add function getConfigPortalPW()
8+
2. Add 4 new complicated examples compatible with ArduinoJson 6.0.0+ :[AutoConnect](examples/AutoConnect), [AutoConnectWithFeedback](examples/AutoConnectWithFeedback), [AutoConnectWithFeedbackLED](examples/AutoConnectWithFeedbackLED) and [AutoConnectWithFSParameters](examples/AutoConnectWithFSParameters)
9+
510
This library is based on, modified, bug-fixed and improved from:
611

712
1. [`Tzapu WiFiManager`](https://github.com/tzapu/WiFiManager)
@@ -14,10 +19,11 @@ It's using a web configuration portal, served from the `ESP32 / ESP8266`, and op
1419

1520
The configuration portal is captive, so it will present the configuration dialogue regardless of the web address selected, excluding https requests.
1621

17-
This works with
18-
1. The `ESP8266` Arduino platform with a recent stable release [`ESP8266 Core 2.6.3 or newer`](https://github.com/esp8266/Arduino)
19-
2. The `ESP32` Arduino platform with a recent stable release [`ESP32 Core 1.0.4 or newer`](https://github.com/espressif/arduino-esp32)
20-
22+
## Prerequisite
23+
1. [`Arduino IDE 1.8.12 or later` for Arduino](https://www.arduino.cc/en/Main/Software)
24+
2. `Arduino AVR core 1.8.2 or later` for Arduino (Use Arduino Board Manager)
25+
3. [`ESP8266 Core 2.6.3 or newer`](https://github.com/esp8266/Arduino) for ESP8266-based boards.
26+
4. [`ESP32 Core 1.0.4 or newer`](https://github.com/espressif/arduino-esp32) for ESP32-based boards
2127

2228
## How It Works
2329

@@ -33,16 +39,20 @@ This works with
3339

3440
## Quick Start
3541

42+
The suggested way to install is to:
43+
3644
### Installing
3745

38-
The easiest way is to use Arduino Library Manager. Search for ESP_WiFiManager, then select / install the latest version.
46+
#### Use Arduino Library Manager
47+
The best and easiest way is to use `Arduino Library Manager`. Search for `ESP_WiFiManager`, then select / install the latest version. You can also use this link [![arduino-library-badge](https://www.ardu-badge.com/badge/ESP_WiFiManager.svg?)](https://www.ardu-badge.com/ESP_WiFiManager) for more detailed instructions.
3948

40-
#### Compatibility
41-
Github version `1.0.2` currently works with :
42-
1. release `2.6.3` or newer of the [ESP8266 core for Arduino](https://github.com/esp8266/Arduino)
43-
2. release `1.0.4` or newer of the [ESP32 core for Arduino](https://github.com/espressif/arduino-esp32)
49+
#### Manual Install
4450

45-
- Checkout [library](https://github.com/khoih-prog/ESP_WiFiManager) to your Arduino libraries folder. Must be [https://github.com/khoih-prog/ESP_WiFiManager](https://github.com/khoih-prog/ESP_WiFiManager) version.
51+
1. Navigate to [ESP_WiFiManager](https://github.com/khoih-prog/ESP_WiFiManager) page.
52+
2. Download the latest release `ESP_WiFiManager-master.zip`.
53+
3. Extract the zip file to `ESP_WiFiManager-master` directory
54+
4. Copy whole
55+
- `ESP_WiFiManager-master/src` folder to Arduino libraries' directory such as `~/Arduino/libraries/`.
4656

4757
### Using
4858
- Include in your sketch
@@ -367,7 +377,7 @@ If you connect to the created configuration Access Point but the configuration p
367377

368378
### Releases 1.0.2
369379

370-
- Forked, modified, bug-fixed and improved from these versions of WiFiManager.
380+
- Based on, modified, bug-fixed and improved from these versions of WiFiManager.
371381

372382
See [Tzapu's version](https://github.com/tzapu/WiFiManager) for previous release information.
373383
See [KenTaylor's version](https://github.com/kentaylor/WiFiManager) for previous release information.
@@ -378,9 +388,10 @@ See [KenTaylor's version](https://github.com/kentaylor/WiFiManager) for previous
378388
- Add example ConfigPortalParamsOnSwitch to enable ConfigPortal credentials to be reconfigurable using ConfigPortal.
379389

380390
### Contributions and thanks
381-
1. Forked from [Tzapu](https://github.com/tzapu/WiFiManager) and [KenTaylor's version]( https://github.com/kentaylor/WiFiManager)
391+
1. Based on and modified from [Tzapu](https://github.com/tzapu/WiFiManager) and [KenTaylor's version]( https://github.com/kentaylor/WiFiManager)
382392
2. Thanks to [Amorphous](https://community.blynk.cc/t/esp-wifimanager-for-esp32-and-esp8266/42257/13) for the static DNS feature and code, included in v1.0.5
383393
3. Thanks to [CrispinP](https://github.com/CrispinP) for idea to add HostName (v1.0.4) and request to reduce the unnecessary waiting time in ESP_WiFiManager constructor (v1.0.6+).
394+
4. Thanks to [OttoKlaasen](https://github.com/OttoKlaasen) for reporting [Having issue to read the SPIFF file](https://github.com/khoih-prog/ESP_WiFiManager/issues/14) bug.
384395

385396
### Contributing
386397

0 commit comments

Comments
 (0)