Skip to content

Commit 49acb45

Browse files
author
Julien Bouquillon
committed
docs
1 parent 1b4de4b commit 49acb45

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# react-orbitdb
22

3+
[![](https://img.shields.io/badge/License-Apache--2.0-yellow.svg)](https://opensource.org/licenses/Apache-2.0)
4+
[![](https://img.shields.io/npm/v/react-orbitdb.svg)](https://www.npmjs.com/package/react-orbitdb)
5+
36
react hooks and providers for dealing with [IPFS](https://ipfs.io) [orbit-db datasources](https://github.com/orbitdb/orbit-db).
47

8+
You can see a demo here : https://revolunet.github.io/react-orbitdb
9+
510
## Provider
611

712
`OrbitProvider` creates a shared IPFS Node and an orbit-db instance.
@@ -10,6 +15,8 @@ react hooks and providers for dealing with [IPFS](https://ipfs.io) [orbit-db dat
1015
const App = () => <OrbitProvider>...</OrbitProvider>;
1116
```
1217

18+
- `config` prop with ipfs configuration can be passer to the provider. (see the [default](./src/ipfs-config.js)
19+
1320
## Hooks
1421

1522
#### useOrbitDb

0 commit comments

Comments
 (0)