fluencelabs/rust-libp2p
1
0
Fork 0
mirror of https://github.com/fluencelabs/rust-libp2p synced 2025-06-20 13:26:34 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #39 from tomaka/readme-work

Browse Source 
Start writing about the architecture of the repository
This commit is contained in:
tomaka
2017-11-19 12:37:29 +01:00
committed by GitHub
parent 671e867abf c958a12ab9
commit 9fb030c298
1 changed files with 13 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -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 This readme along with many others will be more fleshed out the closer
the project gets to completion. Right now everything including the crate the project gets to completion. Right now everything including the crate
organization is very much Work in Progress. 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.