Browse Source

Merge pull request #1108 from tendermint/zramsay-patch-1

Update p2p README
pull/1074/merge
Ethan Buchman 7 years ago
committed by GitHub
parent
commit
c1e6e73bb1
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 24 deletions
  1. +0
    -13
      p2p/Dockerfile
  2. +8
    -11
      p2p/README.md

+ 0
- 13
p2p/Dockerfile View File

@ -1,13 +0,0 @@
FROM golang:latest
RUN curl https://glide.sh/get | sh
RUN mkdir -p /go/src/github.com/tendermint/tendermint/p2p
WORKDIR /go/src/github.com/tendermint/tendermint/p2p
COPY glide.yaml /go/src/github.com/tendermint/tendermint/p2p/
COPY glide.lock /go/src/github.com/tendermint/tendermint/p2p/
RUN glide install
COPY . /go/src/github.com/tendermint/tendermint/p2p

+ 8
- 11
p2p/README.md View File

@ -1,14 +1,11 @@
# `tendermint/tendermint/p2p`
# p2p
[![CircleCI](https://circleci.com/gh/tendermint/tendermint/p2p.svg?style=svg)](https://circleci.com/gh/tendermint/tendermint/p2p)
The p2p package provides an abstraction around peer-to-peer communication.
`tendermint/tendermint/p2p` provides an abstraction around peer-to-peer communication.<br/>
See:
- [docs/connection] for details on how connections and multiplexing work
- [docs/peer] for details on peer ID, handshakes, and peer exchange
- [docs/node] for details about different types of nodes and how they should work
- [docs/pex] for details on peer discovery and exchange
- [docs/config] for details on some config options
Docs:
- [Connection](../docs/specification/new-spec/p2p/connection.md) for details on how connections and multiplexing work
- [Peer](../docs/specification/new-spec/p2p/peer.md) for details on peer ID, handshakes, and peer exchange
- [Node](../docs/specification/new-spec/p2p/node.md) for details about different types of nodes and how they should work
- [Pex](../docs/specification/new-spec/p2p/pex.md) for details on peer discovery and exchange
- [Config](../docs/specification/new-spec/p2p/config.md) for details on some config option

Loading…
Cancel
Save