Skip to content

Commit 684b1e1

Browse files
author
Christopher J. Brody
committed
getting started doc updates
1 parent bee3981 commit 684b1e1

File tree

1 file changed

+19
-1
lines changed

1 file changed

+19
-1
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,12 +27,29 @@ The primary author and maintainer [@brodybits (Chris Brody)](https://github.com/
2727

2828
# Getting started on React Native
2929

30+
## Demo app
31+
32+
- <https://github.com/brodybits/react-native-sqlite-plugin-legacy-demo>
33+
34+
## Adding to an existing React Native project
35+
36+
NOTE that using the Yarn tool is HIGHLY RECOMMENDED. Use without Yarn is NOT TESTED AND NOT SUPPORTED.
37+
38+
Add to an existing React Native project as follows:
39+
40+
```sh
41+
yarn add https://github.com/brodybits/react-native-sqlite-plugin-legacy-support
42+
```
43+
44+
<!-- ALTERNATIVE THAT IS NOT TESTED AND NOT SUPPORTED:
3045
`$ npm install react-native-sqlite-plugin-legacy-support --save`
46+
-- -->
3147

32-
### Mostly automatic installation
48+
and then continue with the following "mostly automatic installation" command:
3349

3450
`$ react-native link react-native-sqlite-plugin-legacy-support`
3551

52+
<!-- NOT TESTED AND NOT SUPPORTED:
3653
### Manual installation
3754
3855
NOTE THAT MANUAL INSTALLATION OF THIS REACT NATIVE MODULE IS NOT TESTED AND NOT SUPPORTED.
@@ -60,6 +77,7 @@ project(':react-native-sqlite-plugin-legacy-support').projectDir = new File(root
6077
```
6178
compile project(':react-native-sqlite-plugin-legacy-support')
6279
```
80+
- -->
6381

6482
# Usage
6583

0 commit comments

Comments
 (0)