Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
philcockfield authored Feb 28, 2024
1 parent 7d46c85 commit 734f679
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@
A network adapter for WebRTC, based on the point-to-point [MessageChannelNetworkAdapter](https://github.com/automerge/automerge-repo/blob/main/packages/automerge-repo-network-messagechannel/src/index.ts).


**Please Note:** This is not an official part of the [automerge-repo](https://github.com/automerge/automerge-repo) project, rather a community contribution that includes a dependency on the [peerjs](https://github.com/peers/peerjs) library.

<p>&nbsp;</p>


## Setup
```
yarn add automerge-repo-network-peerjs
```

<p>&nbsp;</p>

## Usage

Establish a data connection as per [peerjs](https://github.com/peers/peerjs#data-connections) documentation:
Expand Down Expand Up @@ -38,6 +41,14 @@ function monitor(adapter: PeerjsNetworkAdapter, dispose$?: Observable<any>) {

```

<p>&nbsp;</p>


## Licence
MIT

<p>&nbsp;</p>

---
**Please Note:**
This is not an official part of the [automerge-repo](https://github.com/automerge/automerge-repo) project, rather a community contribution that includes a dependency on the [peerjs](https://github.com/peers/peerjs) library.

0 comments on commit 734f679

Please sign in to comment.