Skip to content

Commit f973dea

Browse files
authored
README: add section on Upgrading (WiseLibs#1300)
See: WiseLibs#1277 Co-authored-by: alxndrsn <alxndrsn>
1 parent 65f4b9d commit f973dea

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ If you have a performance problem, the most likely causes are inefficient querie
7676

7777
For these situations, you should probably use a full-fledged RDBMS such as [PostgreSQL](https://www.postgresql.org/).
7878

79+
## Upgrading
80+
81+
Upgrading your `better-sqlite3` dependency can potentially introduce breaking changes, either in the `better-sqlite3` API, or between your existing database(s) and the underlying version of SQLite. Before upgrading, review:
82+
83+
* `better-sqlite3` release notes: https://github.com/WiseLibs/better-sqlite3/releases
84+
* SQLite changelog: https://www.sqlite.org/changes.html
85+
7986
# Documentation
8087

8188
- [API documentation](./docs/api.md)

0 commit comments

Comments
 (0)