swarm operations for cobox
kyphae 28ef495ab9 Merge branch 'update-for-hypercore-8' of CoBox/cobox-swarm into development 2 years ago
lib check discovery key 2 years ago
LICENSE initial commit 2 years ago
README.md update README 2 years ago
index.js use hyperswarm be default 2 years ago
package.json initial commit 2 years ago
yarn.lock small refactor, and assume group has connection functions... 2 years ago

README.md

cobox-swarm

swarm operation for cobox.

API

const Swarm = require('cobox-swarm')

let swarm = Swarm(group, opts)

Starts swarming and returns the swarm stream

  • group a group object from cobox-group
  • opts an options object which may contain:
    • opts.hyperswarm Use hyperswarm instead of discovery-swarm?
    • opts.logger - an custom logger. Defaults to debug('cobox-swarm')