git ssb

0+

Piet / ssb-loomio



Tree: 6b40ec5cf68a4d01c36667b30a3801ff6d313c4e

Files: 6b40ec5cf68a4d01c36667b30a3801ff6d313c4e / README.md

1247 bytesRaw

ssb-loomio-schema

Create and vote on polls on ssb

background details relevant to understanding what this module does

Usage

var ssbLoomio = require('ssb-loomio')

console.log('hello warld')

outputs

hello warld

API

var ssbLoomio = require('ssb-loomio')

See api_formatting.md for tips.

Install

With npm installed, run

$ npm install ssb-loomio

Schemas

Poll message content

{
  type: 'poll', // required
  pollType: oneOf:[dot, proposal, score] , // required
  text: String, // required
  mentions, //optional
}

Dot vote pollType

{
  type: 'dot', // required
  maxStanceScore: 'Integer >= 0', // required
  maxChoiceScore: 'Integer >= 0', //optional
  choices: Array, // required
}

Proposal pollType

{
  type: 'proposal', // required
  proposal: String, // required
}

Score pollType

{
  type: 'score', // required
  maxChoiceScore: 'Integer >= 0', //required
  choices: Array, // required
}

Position



Acknowledgments

ssb-loomio was inspired by loomio! Massive thanks to Rob Guthrie and James Kiesel for spending time giving us a brain dump of their data model.

See Also

License

MIT

Built with git-ssb-web