js-libp2p-noise/README.md

31 lines
922 B
Markdown
Raw Normal View History

2019-10-30 12:12:38 +01:00
# js-libp2p-noise
2019-10-30 15:09:08 +01:00
[![](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)
> Noise libp2p handshake for js-libp2p
This repository contains TypeScript implementation of noise protocol, an encryption protocol used in libp2p.
## Usage
2019-12-03 15:22:24 +01:00
TBD (package not yet published)
2019-10-30 15:09:08 +01:00
## API
2019-12-03 15:22:24 +01:00
This module exposes a crypto interface, as defined in the repository [js-interfaces](https://github.com/libp2p/js-interfaces).
[» API Docs](https://github.com/libp2p/js-interfaces/tree/master/src/crypto#api)
## Contribute
Feel free to join in. All welcome. Open an issue!
[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)
## License
[MIT](LICENSE)