Skip to content

Commit 42dc385

Browse files
committed
Add Breaking Changes section to README
1 parent a9c458e commit 42dc385

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,6 @@ sqlite modern cpp wrapper
55

66
This library is a lightweight modern wrapper around sqlite C api .
77

8-
**Heads up!**
9-
The current master contains a _breaking change_ compared to the 2.4 release for database names with non-ASCII characters. For details, see [issue 82](https://github.com/aminroosta/sqlite_modern_cpp/issues/82).
10-
118
```c++
129
#include<iostream>
1310
#include <sqlite_modern_cpp.h>
@@ -324,6 +321,12 @@ The usual way works for installing:
324321

325322
Note, there's nothing to make, so you there's no need to run configure and you can simply point your compiler at the hdr/ directory.
326323

324+
Breaking Changes
325+
----
326+
327+
- Databases with non-ASCII characters in their names created with versions up to 2.4 are not found by the current master.
328+
You have to manually rename them to their actual (UTF-8 encoded) name.
329+
327330
Package managers
328331
----
329332
Pull requests are welcome :wink:

0 commit comments

Comments
 (0)