A consensus interface for LibP2P
Switch branches/tags
Nothing to show
Clone or download
hsanjuan Improve readme with badges, add Makefile, enable travis
License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
Latest commit f1af2e7 Nov 16, 2016

README.md

go-libp2p-consensus

standard-readme compliant GoDoc Build Status

A Consensus interface for LibP2P

The LibP2P Consensus interface allows to abstract different consensus algorithms implemented for libp2p with an standarized layer so they can be swapped seamlessly.

Table of Contents

Install

Simply go-get the module:

go get -u github.com/libp2p/go-libp2p-consensus

You can run make deps and make test, although they do very little because this module only declares some interfaces.

Usage

In a different project just:

import "github.com/libp2p/go-libp2p-consensus"

This module is published as a GX dependency. So you can also import in GX with:

> gx import github.com/libp2p/go-libp2p-consensus

The code is documented in godoc.org/github.com/libp2p/go-libp2p-consensus.

Contribute

PRs accepted.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Protocol Labs, Inc.