cyclon.p2p-rtc-comms

A WebRTC communications module for the cyclon.p2p framework


Keywords
webrtc, cyclon.p2p
License
MIT
Install
npm install cyclon.p2p-rtc-comms@0.1.28

Documentation

cyclon.p2p-rtc-comms

Build Status Dependencies

A WebRTC implementation of the cyclon.p2p Comms and Bootstrap interfaces.

This project implements the cyclon.p2p Comms and Bootstrap interfaces using cyclon.p2p-rtc-client. For more information about the Comms and Bootstrap interfaces, see cyclon.p2p.

How to use

First install cyclon.p2p-rtc-comms and cyclon.p2p as runtime dependencies using npm

npm install cyclon.p2p-rtc-comms --save
npm install cyclon.p2p --save

Create a Comms and Bootstrap instance using the builder provided, e.g.

const {commsAndBootstrapBuilder} = require('cyclon.p2p-rtc-comms');
const {builder} = require('cyclon.p2p');

const { comms, bootstrap } = commsAndBootstrapBuilder().build();
const cyclonNode = builder(comms, bootstrap).build();
cyclonNode.start();