Skip to content

Latest commit

 

History

History
62 lines (51 loc) · 2.13 KB

edify.md

File metadata and controls

62 lines (51 loc) · 2.13 KB

Actions Status codecov License: MIT

An atomic log with a parititioned consensus algorithm.

What Where
Discussion #1
Documentation https://bigeasy.github.io/sympatico
Source https://github.com/bigeasy/sympatico
Issues https://github.com/bigeasy/sympatico/issues
CI https://travis-ci.org/bigeasy/sympatico
Coverage: https://codecov.io/gh/bigeasy/sympatico
License: MIT

Sympatico installs from NPM.

//{ "mode": "text" }
npm install sympatico

This README.md is also a unit test using the Proof unit test framework. We'll use the Proof okay function to assert out statements in the readme. A Proof unit test generally looks like this.

//{ "code": { "tests": 1 }, "text": { "tests": 4  } }
require('proof')(%(tests)d, async okay => {
    //{ "include": "test", "mode": "code" }
    //{ "include": "proof", "mode": "text" }
})
//{ "name": "proof", "mode": "text" }
okay('always okay')
okay(true, 'okay if true')
okay(1, 1, 'okay if equal')
okay({ value: 1 }, { value: 1 }, 'okay if deep strict equal')

You can run this unit test yourself to see the output from the various code sections of the readme.

//{ "name": "run", "mode": "text" }
git clone [email protected]:bigeasy/packet.git
cd packet
npm install --no-package-lock --no-save
node --allow-natives-syntax test/readme/readme.t.js

Further Documentation

//{ "name": "test", "code": { "path": ".." }, "text": { "path": "packet"  } }
const Sympatico = require('%(path)s/phaser')
okay(Sympatico, 'require')