mirror of
https://github.com/fluencelabs/js-libp2p-crypto
synced 2025-03-15 21:50:54 +00:00
59 lines
2.2 KiB
Markdown
59 lines
2.2 KiB
Markdown
# js-libp2p-crypto
|
|
|
|
[](http://ipn.io)
|
|
[](http://ipfs.io/)
|
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
[](https://coveralls.io/github/libp2p/js-libp2p-crypto?branch=master)
|
|
[](https://travis-ci.org/libp2p/js-libp2p-crypto)
|
|
[](https://circleci.com/gh/libp2p/js-libp2p-crypto)
|
|
[](https://david-dm.org/libp2p/js-libp2p-crypto)
|
|
[](https://github.com/feross/standard)
|
|
|
|
> Crypto primitives for libp2p in JavaScript
|
|
|
|
This repo contains the JavaScript implementation of the crypto primitives
|
|
needed for libp2p. This is based on this [go implementation](https://github.com/ipfs/go-libp2p-crypto).
|
|
|
|
## Table of Contents
|
|
|
|
- [Install](#install)
|
|
- [Usage](#usage)
|
|
- [Example](#example)
|
|
- [API](#api)
|
|
- [Contribute](#contribute)
|
|
- [License](#license)
|
|
|
|
## Install
|
|
|
|
```sh
|
|
npm install --save libp2p-crypto
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Example
|
|
|
|
```js
|
|
const crypto = require('libp2p-crypto')
|
|
|
|
crypto.generateKeyPair('RSA', 2048, (err, key) => {
|
|
})
|
|
```
|
|
|
|
## API
|
|
|
|
See [API.md](API.md)
|
|
|
|
## Contribute
|
|
|
|
Feel free to join in. All welcome. Open an [issue](https://github.com/ipfs/js-libp2p-crypto/issues)!
|
|
|
|
This repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
|
|
|
|
[](https://github.com/ipfs/community/blob/master/contributing.md)
|
|
|
|
## License
|
|
|
|
[MIT](LICENSE)
|