From c958a12ab904967c4207b5434c9e00c6bf91b90c Mon Sep 17 00:00:00 2001 From: Pierre Krieger Date: Fri, 17 Nov 2017 15:38:53 +0100 Subject: [PATCH] Start writing about the architecture of the crate --- README.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/README.md b/README.md index 45d45d00..e716fcfe 100644 --- a/README.md +++ b/README.md @@ -6,3 +6,16 @@ This repository is the central place for rust development of the This readme along with many others will be more fleshed out the closer the project gets to completion. Right now everything including the crate organization is very much Work in Progress. + +## General overview of the architecture + +Architecture of the crates of this repository: + +- `datastore`: Utility library whose API provides a key-value storage with multiple possible + backends. +- `libp2p-host`: Stub. Will probably get reworked or removed. +- `libp2p-tcp-transport`: Implementation of the `Transport` trait for TCP/IP. +- `libp2p-transport`: Contains the `Transport` trait. Will probably get reworked or removed. +- `multistream-select`: Implementation of the `multistream-select` protocol, which is used to + negotiate a protocol over a newly-established connection with a peer, or after a connection + upgrade.