Skip to content

Commit

Permalink
README.md: Include links to network docs
Browse files Browse the repository at this point in the history
  • Loading branch information
coot committed Sep 14, 2020
1 parent cae8129 commit ba34791
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions README.md
Expand Up @@ -14,6 +14,27 @@
* The [`byron-proxy`](https://github.com/input-output-hk/cardano-byron-proxy) is a network protocol proxy between Byron and Shelley.
It now lives in a seaprate repository.

## Ouroboros-Network Documentation

We have two documents which describe various levels of the networking layer of
the Cardano Shelley implementation:

* _Introduction to the design of Data Diffusion and Networking of Cardano Shelley_

This document explains the technical requirements and key constraints for the networking
layer of the _Cardano Shelley_ implementation of _Ouroboros Praos_. This is
a design document.

* _The Shelley Networking Protocol_

This document is a technical specification of the networking protocol. It
includes serialisation formats, necessary details of multiplexer and
technical specifications of mini-protocols used by either _node-to-node_ and
_node-to-client_ flavors of the protocol.

The latest versions of the two documents can be found
[here](https://hydra.iohk.io/job/Cardano/ouroboros-network/native.docs.x86_64-linux/latest).

## Ouroboros-Network API

The API consisists of three layers:
Expand Down

0 comments on commit ba34791

Please sign in to comment.