Skip to content

Commit e8f7594

Browse files
committed
Add readme
1 parent 4b82097 commit e8f7594

2 files changed

Lines changed: 14 additions & 10 deletions

File tree

README.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# react-native-sqlite-explorer
22

3-
Explorer for sqlite database inside react native app
3+
Explorer for react-native-sqlite-storage library database inside react native app
44

55
## Installation
66

@@ -10,19 +10,23 @@ npm install react-native-sqlite-explorer
1010

1111
## Usage
1212

13-
1413
```js
15-
import { multiply } from 'react-native-sqlite-explorer';
14+
import SQLiteExplorer from 'react-native-sqlite-explorer';
1615

17-
// ...
16+
const DBExplorer = () => {
17+
// your baseName that you used in params:
18+
// SQLite.openDatabase({ name: baseName, location: 'default' }....
19+
const baseName = '<your_base_name_here>';
1820

19-
const result = await multiply(3, 7);
20-
```
21+
return <SQLiteExplorer params={{ name: baseName, location: 'default' }} />;
22+
};
2123

24+
export default DBExplorer;
25+
```
2226

23-
## Contributing
27+
## Tips
2428

25-
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
29+
Temporarily only for Android
2630

2731
## License
2832

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "react-native-sqlite-explorer",
3-
"version": "0.1.4",
4-
"description": "Explorer for sqlite database inside react native app",
3+
"version": "0.1.5",
4+
"description": "Explorer for react-native-sqlite-storage library database inside react native app",
55
"source": "./src/index.tsx",
66
"main": "./lib/commonjs/index.js",
77
"module": "./lib/module/index.js",

0 commit comments

Comments
 (0)