Skip to content

Commit

Permalink
Add Breaking Changes section to README
Browse files Browse the repository at this point in the history
  • Loading branch information
zauguin committed Feb 9, 2017
1 parent a9c458e commit 42dc385
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,6 @@ sqlite modern cpp wrapper

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

**Heads up!**
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).

```c++
#include<iostream>
#include <sqlite_modern_cpp.h>
Expand Down Expand Up @@ -324,6 +321,12 @@ The usual way works for installing:

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.

Breaking Changes
----

- Databases with non-ASCII characters in their names created with versions up to 2.4 are not found by the current master.
You have to manually rename them to their actual (UTF-8 encoded) name.

Package managers
----
Pull requests are welcome :wink:
Expand Down

0 comments on commit 42dc385

Please sign in to comment.