@coboxcoop/schemas
v1.0.0-alpha.1
Published
schemas and buffer encoders for log messages
Downloads
22
Readme
schemas
Table of Contents
About
CoBox is an encrypted p2p file system and distributed back-up tool. README provides a map of the project.
schemas
exports a set of object factories for use with a hypercore. Factories build payloads for a cobox-log using JSON schemas for validation and Protocol Buffers for encoding.
Install
npm i -g @coboxcoop/schemas
Usage
This module also exports all currently used message schemas in CoBox as raw validators and encoders.
See /test
for examples
In order to use the protocol-buffers message encoders, you'll need to pre-compile them.
npm run compile
API
See swagger documentation... (we won't have this for a while).
Contributing
PRs accepted.
Small note: If editing the README, please conform to the standard-readme specification.