Skip to content

Commit

Permalink
Add readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Henus321 committed Aug 23, 2024
1 parent 4b82097 commit e8f7594
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 10 deletions.
20 changes: 12 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# react-native-sqlite-explorer

Explorer for sqlite database inside react native app
Explorer for react-native-sqlite-storage library database inside react native app

## Installation

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

## Usage


```js
import { multiply } from 'react-native-sqlite-explorer';
import SQLiteExplorer from 'react-native-sqlite-explorer';

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

const result = await multiply(3, 7);
```
return <SQLiteExplorer params={{ name: baseName, location: 'default' }} />;
};

export default DBExplorer;
```

## Contributing
## Tips

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

## License

Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "react-native-sqlite-explorer",
"version": "0.1.4",
"description": "Explorer for sqlite database inside react native app",
"version": "0.1.5",
"description": "Explorer for react-native-sqlite-storage library database inside react native app",
"source": "./src/index.tsx",
"main": "./lib/commonjs/index.js",
"module": "./lib/module/index.js",
Expand Down

0 comments on commit e8f7594

Please sign in to comment.