diff --git a/README.md b/README.md index 8a1835e..b7d6a7e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,10 @@ [![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/) ![](https://img.shields.io/github/issues-raw/nodefactoryio/js-libp2p-noise) ![](https://img.shields.io/github/license/nodefactoryio/js-libp2p-noise) +[![Build Status](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise.svg?branch=master)](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise) +![](https://img.shields.io/badge/yarn-%3E%3D1.17.0-orange.svg?style=flat-square) +![](https://img.shields.io/badge/Node.js-%3E%3D12.4.0-orange.svg?style=flat-square) +[![Discourse posts](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg)](https://discuss.libp2p.io) > Noise libp2p handshake for js-libp2p @@ -10,7 +14,25 @@ This repository contains TypeScript implementation of noise protocol, an encrypt ## Usage -TBD (package not yet published) +When published, package should be imported as: `import { Noise } from 'libp2p-noise'`. + +Example of instantiating noise and passing it to the libp2p config: +``` +const NOISE = new Noise(privateKey); + +const libp2p = new Libp2p({ + modules: { + connEncryption: [NOISE], + }, +}); +``` + +Where parameters for Noise constructor are: + - *private key* - required parameter (32 bytes libp2p peer private key) + - *static Noise key* - (optional) existing private Noise static key + - *early data* - (optional) an early data payload to be sent in handshake messages + + ## API