Skip to content

Improve README.md to match current API#253

Merged
chrispader merged 1 commit intomainfrom
chore/improve-readme
Feb 4, 2026
Merged

Improve README.md to match current API#253
chrispader merged 1 commit intomainfrom
chore/improve-readme

Conversation

@chrispader
Copy link
Member

@chrispader chrispader commented Feb 4, 2026

Note

Low Risk
Documentation-only changes that reorganize and correct API examples; no runtime code is modified.

Overview
Updates README.md to reflect the current react-native-nitro-sqlite connection-based API: introduces an API overview table, clarifies sync vs async behavior, and refreshes examples for open, execute*, transaction, executeBatch*, loadFile*, attach/detach, and column metadata.

Removes outdated sections (notably detailed null-handling guidance and older API snippets), adds guidance for opening existing DB files, updates TypeORM integration steps, and documents configuration options (system SQLite on iOS, compile-time flags, app groups) plus an explicit exports list.

Written by Cursor Bugbot for commit 8f55c9f. This will update automatically on new commits. Configure here.

@chrispader chrispader merged commit 9e3ca8f into main Feb 4, 2026
1 check was pending
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant