Skip to content

Commit b425267

Browse files
authored
Update README.md
1 parent a82168a commit b425267

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

README.md

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,18 +15,24 @@
1515
1616
<div align="center">
1717
<pre align="center">
18-
bun add react-native-nitro-sqlite
18+
npm i react-native-nitro-sqlite react-native-nitro-modules
1919
npx pod-install</pre>
20-
<a align="center" href="https://github.com/mrousavy?tab=followers">
21-
<img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
20+
<a align="center" href="https://github.com/margelo">
21+
<img src="https://img.shields.io/github/followers/margelo?label=Follow%20%40margelo&style=social" />
2222
</a>
2323
<br />
2424
<a align="center" href="https://twitter.com/margelo_io">
2525
<img src="https://img.shields.io/twitter/follow/margelo_io?label=Follow%20%40margelo_io&style=social" />
2626
</a>
27+
<a align="center" href="https://bsky.app/profile/margelo.com">
28+
<img src="https://img.shields.io/twitter/follow/margelo_com?label=Follow%20%40margelo_com&style=social&logo=bluesky&url=https%3A%2F%2Fbsky.app%2Fprofile%2Fmargelo.com" style="pointer-events: 'none'" />
29+
</a>
2730
</div>
2831
<br />
2932

33+
> [!NOTE]
34+
> `react-native-nitro-sqlite` is based on [Nitro modules](https://nitro.margelo.com/). You need to install `react-native-nitro-modules` as a dependency.
35+
3036
Nitro SQLite embeds the latest version of SQLite and provides a low-level JSI-backed API to execute SQL queries.
3137

3238
Performance metrics are intentionally not presented, [anecdotic testimonies](https://dev.to/craftzdog/a-performant-way-to-use-pouchdb7-on-react-native-in-2022-24ej) suggest anywhere between 2x and 5x speed improvement. On small queries you might not notice a difference with the old bridge but as you send large data to JS the speed increase is considerable.
@@ -248,7 +254,7 @@ Starting on Node14 all files that need to be accessed by third-party modules nee
248254
After you have applied that change, do:
249255

250256
```sh
251-
bun patch-package --exclude 'nothing' typeorm
257+
npx patch-package --exclude 'nothing' typeorm
252258
```
253259

254260
Now every time you install your node_modules that line will be added.
@@ -273,7 +279,7 @@ plugins: [
273279
You will need to install the babel `module-resolver` plugin:
274280

275281
```sh
276-
bun add babel-plugin-module-resolver
282+
npx add babel-plugin-module-resolver
277283
```
278284

279285
Finally, you will now be able to start the app without any metro/babel errors (you will also need to follow the instructions on how to setup TypeORM), now we can feed the driver into TypeORM:

0 commit comments

Comments
 (0)