libp2p-tcp - npm Package Compare versions

Comparing version 0.8.0 to 0.8.1

package.json

 {
   "name": "libp2p-tcp",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
@@ -5,0 +5,0 @@ "main": "lib/index.js",

README.md

@@ -15,4 +15,2 @@ # js-libp2p-tcp
 
-## Description
-
 `libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
@@ -22,4 +20,26 @@
 
-## Example
+## Table of Contents
 
+- [Install](#install)
+  - [npm](#npm)
+- [Usage](#usage)
+  - [Example](#example)
+  - [This module uses `pull-streams`](#this-module-uses-pull-streams)
+    - [Converting `pull-streams` to Node.js Streams](#converting-pull-streams-to-nodejs-streams)
+- [API](#api)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Install
+
+### npm
+
+```sh
+> npm i libp2p-tcp
+```
+
+## Usage
+
+### Example
+
 ```js
@@ -56,5 +76,5 @@ const TCP = require('libp2p-tcp')
 
-outputs
+Outputs:
 
-```
+```sh
 listening
@@ -65,14 +85,6 @@ new connection opened
 
-## Installation
+### This module uses `pull-streams`
 
-### npm
+We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
 
-```sh
-> npm i libp2p-tcp
-```
-
-## This module uses `pull-streams`
-
-We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about what took us to make this migration, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
-
 You can learn more about pull-streams at:
@@ -85,7 +97,7 @@
 
-### Converting `pull-streams` to Node.js Streams
+#### Converting `pull-streams` to Node.js Streams
 
-If you are a Node.js streams user, you can convert a pull-stream to Node.js Stream using the module `pull-stream-to-stream`, giving you an instance of a Node.js stream that is linked to the pull-stream. Example:
+If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/dominictarr/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
 
-```
+```js
 const pullToStream = require('pull-stream-to-stream')
@@ -97,3 +109,3 @@
 
-To learn more about his utility, visit https://pull-stream.github.io/#pull-stream-to-stream
+To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
 
@@ -111,4 +123,16 @@ ## API
 
+## Contribute
+
+Contributions are welcome! The libp2p implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
+
+- [Check out the existing issues](//github.com/libp2p/js-libp2p-tcp/issues).
+- **Perform code reviews**.
+- **Add tests**. There can never be enough tests.
+
+Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
+
+Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+
 ## License
 
-MIT
+[MIT](LICENSE) © 2015-2016 David Dias

Fixed alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

21879

increased by5.02%

Number of lines in readme file

132

increased by22.22%

Number of medium supply chain risk alerts

4

decreased by-20%

No dependency changes