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

Commit 3d99776

Browse files
authored
Update README.md
Update README.md to add warning about `Breaking Change` in v1.10.0
1 parent bf9adab commit 3d99776

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111

1212
## Table of Contents
1313

14+
* [Important Breaking Change from v1.10.0](#Important-Breaking-Change-from-v1100)
1415
* [Why do we need this ESPAsync_WiFiManager library](#why-do-we-need-this-async-espasync_wifimanager-library)
1516
* [Features](#features)
1617
* [Why Async is better](#why-async-is-better)
@@ -145,6 +146,28 @@
145146
---
146147
---
147148

149+
### Important Breaking Change from v1.10.0
150+
151+
Please have a look at [HOWTO Fix `Multiple Definitions` Linker Error](#howto-fix-multiple-definitions-linker-error)
152+
153+
From v1.10.0, you must use
154+
155+
```
156+
#include <ESPAsync_WiFiManager.h> //https://github.com/khoih-prog/ESPAsync_WiFiManager
157+
158+
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
159+
#include <ESPAsync_WiFiManager-Impl.h> //https://github.com/khoih-prog/ESPAsync_WiFiManager
160+
```
161+
162+
instead of only
163+
164+
```
165+
#include <ESPAsync_WiFiManager.h> //https://github.com/khoih-prog/ESPAsync_WiFiManager
166+
```
167+
168+
---
169+
---
170+
148171
### Why do we need this Async [ESPAsync_WiFiManager library](https://github.com/khoih-prog/ESPAsync_WiFiManager)
149172

150173
#### Features
@@ -286,6 +309,7 @@ You can use
286309
in many files. But be sure to use the following `#include <ESPAsync_WiFiManager-Impl.h>` **in just 1 `.h`, `.cpp` or `.ino` file**, which must **not be included in any other file**, to avoid `Multiple Definitions` Linker Error
287310

288311
```
312+
// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
289313
#include <ESPAsync_WiFiManager-Impl.h> //https://github.com/khoih-prog/ESPAsync_WiFiManager
290314
```
291315

0 commit comments

Comments
 (0)