Skip to content

Commit 744e243

Browse files
committed
docs(readme): add options section
1 parent 8ffe55e commit 744e243

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,17 @@ import PouchDB from './pouchdb'
8181

8282
const pouch = new PouchDB('mydb', {
8383
adapter: 'react-native-sqlite',
84+
// Other options
8485
})
8586
```
8687

88+
### Options
89+
90+
You can specify the following options in the PouchDB options:
91+
92+
- `location`: The location of the SQLite database file. See [op-sqlite's docs](https://op-engineering.github.io/op-sqlite/docs/configuration) for more details.
93+
- `encryptionKey`: The encryption key for SQLCipher. See [op-sqlite's docs](https://op-engineering.github.io/op-sqlite/docs/api#sqlcipher-open) for more details.
94+
8795
## Troubleshootings
8896

8997
### Fails to install crypto shim with `install()` on launch

0 commit comments

Comments
 (0)