fluencelabs/js-libp2p-noise
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-noise synced 2025-04-26 05:42:26 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #28 from NodeFactoryIo/mpetrunic/release-1.0.0-rc

Browse Source 
Release 1.0.0-rc1
This commit is contained in:
Marin Petrunić 2020-02-07 14:16:52 +01:00 committed by GitHub
commit 7e96ebbcf9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 7 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
README.md
View File

@ -1,6 +1,6 @@
# js-libp2p-noise # js-libp2p-noise
![npm](https://img.shields.io/npm/v/@nodefactory/js-libp2p-noise) ![npm](https://img.shields.io/npm/v/libp2p-noise)
[![Build Status](https://travis-ci.com/NodeFactoryIo/js-libp2p-noise.svg?branch=master)](https://travis-ci.com/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/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/) [![](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](https://libp2p.io/)
@ -17,13 +17,14 @@ This repository contains TypeScript implementation of noise protocol, an encrypt
## Usage ## Usage
When published, package should be imported as: `import { Noise } from 'libp2p-noise'`. Install with `yarn add libp2p-noise` or `npm i libp2p-noise`.
Example of using default noise configuration and passing it to the libp2p config: Example of using default noise configuration and passing it to the libp2p config:
``` ```
import {NOISE, Noise} from "@nodefactory/js-libp2p-noise" import {NOISE, Noise} from "libp2p-noise"
//custom noise configuration, pass it instead of NOISE object
//custom noise configuration, pass it instead of NOISE instance
const noise = new Noise(privateKey, Buffer.alloc(), false); const noise = new Noise(privateKey, Buffer.alloc(), false);
const libp2p = new Libp2p({ const libp2p = new Libp2p({

4
package.json
View File

@ -1,6 +1,6 @@
{ {
"name": "js-libp2p-noise", "name": "libp2p-noise",
"version": "1.0.0-rc", "version": "1.0.0-rc1",
"main": "dist/index.js", "main": "dist/index.js",
"module": "lib/index.js", "module": "lib/index.js",
"files": [ "files": [