mirror of
https://github.com/waku-org/js-noise.git
synced 2025-02-24 17:08:10 +00:00
50 lines
1.2 KiB
Markdown
50 lines
1.2 KiB
Markdown
|
# js-noise
|
||
|
|
|
||
|
|
Browser library using Noise Protocols for Waku Payload Encryption
|
||
|
|
https://rfc.vac.dev/spec/35/
|
||
|
|
|
||
|
|
### Install
|
||
|
|
|
||
|
|
```
|
||
|
|
npm install @waku/noise
|
||
|
|
|
||
|
|
# or with yarn
|
||
|
|
|
||
|
|
yarn add @waku/noise
|
||
|
|
```
|
||
|
|
|
||
|
|
### Documentation
|
||
|
|
Refer to the specs and examples for details on how to use this library
|
||
|
|
|
||
|
|
|
||
|
|
### Running example app
|
||
|
|
|
||
|
|
```
|
||
|
|
git clone https://github.com/waku-org/js-noise
|
||
|
|
cd js-noise/example
|
||
|
|
npm install # or yarn
|
||
|
|
npm start
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
Browse http://localhost:8080 to see the webapp where the pairing process can be initiated
|
||
|
|
|
||
|
|
|
||
|
|
## Bugs, Questions & Features
|
||
|
|
|
||
|
|
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-rln/issues/new/).
|
||
|
|
|
||
|
|
For more general discussion, help and latest news, join [Vac Discord](https://discord.gg/PQFdubGt6d) or [Telegram](https://t.me/vacp2p).
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Licensed and distributed under either of
|
||
|
|
|
||
|
|
- MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
|
||
|
|
|
||
|
|
or
|
||
|
|
|
||
|
|
- Apache License, Version 2.0, ([LICENSE-APACHEv2](LICENSE-APACHEv2) or http://www.apache.org/licenses/LICENSE-2.0)
|
||
|
|
|
||
|
|
at your option. These files may not be copied, modified, or distributed except according to those terms.
|