From efb8ece3b313317758c3f0c664cec55eab6969bd Mon Sep 17 00:00:00 2001 From: Ivan Vilata-i-Balaguer Date: Thu, 3 Dec 2015 11:56:00 +0100 Subject: [PATCH] libp2p: minor aesthetic corrections in readme file Fix author list indentation, quote `libp2p`, add link to IPFS web site, fix title capitalization. --- README.md | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index d18c781..962973f 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,23 @@ RFC - libp2p ![](https://raw.githubusercontent.com/diasdavid/specs/libp2p-spec/protocol/network/figs/logo.png) -Authors: -- [Juan Benet](https://github.com/jbenet) -- [David Dias](https://github.com/diasdavid) +Authors: + + - [Juan Benet](https://github.com/jbenet) + - [David Dias](https://github.com/diasdavid) Reviewers: -> tl;dr; This document presents libp2p, a modularized and extensible network stack to overcome the networking challenges faced when doing Peer-to-Peer applications. libp2p is used by IPFS as its networking library. +> tl;dr; This document presents `libp2p`, a modularized and extensible network stack to overcome the networking challenges faced when doing peer-to-peer applications. `libp2p` is used by IPFS as its networking library. * * * # Abstract -This describes the IPFS network protocol. The network layer provides point-to-point transports (reliable and unreliable) between any two IPFS nodes in the network. +This describes the [IPFS](https://ipfs.io/) network protocol. The network layer provides point-to-point transports (reliable and unreliable) between any two IPFS nodes in the network. -This document defines the spec implemented in libp2p. +This document defines the spec implemented in `libp2p`. # Status of this spec @@ -26,9 +27,9 @@ This document defines the spec implemented in libp2p. # Organization of this document -This RFC is organized by chapters described on the `Table of Contents` section. Each of the chapters can be found in its own file. +This RFC is organized by chapters described on the *Table of contents* section. Each of the chapters can be found in its own file. -# Table of Contents +# Table of contents - [1 Introduction](1-introduction.md) - [1.1 Motivation](1-introduction.md#11-motivation)