Skip to content
This repository has been archived by the owner on Aug 22, 2022. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aphelionz committed Sep 22, 2020
1 parent 521c7d8 commit 299b6f3
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,16 @@
# orbit-db-powergate-io

> A bridge between [OrbitDB](https://github.com/orbitdb/orbit-db) and [Powergate](https://docs.textile.io/powergate/), which is itself a bridge between [Filecoin](https://filecoin.io) and [IPFS](https://ipfs.io/).
## Usage

`orbit-db-powergate-io` uses dependency injection of both `orbitdb` and `pow` to work.

For example to use it with a local devnet:

```JavaScript
const pow = createPow({ POWERGATE_URL }) // define this as you will
const ipfs = new IpfsClient() // or await IPFS.create()
orbitdb = await OrbitDB.createInstance(ipfs)
powergateio = await PowergateIO.create(orbitdb, pow)
```

0 comments on commit 299b6f3

Please sign in to comment.