diff --git a/README.md b/README.md index 0b15083..3a120f4 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # 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) [![](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 -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: ``` -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 libp2p = new Libp2p({ diff --git a/package.json b/package.json index ff8ba7b..8cfbc44 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { - "name": "js-libp2p-noise", - "version": "1.0.0-rc", + "name": "libp2p-noise", + "version": "1.0.0-rc1", "main": "dist/index.js", "module": "lib/index.js", "files": [