js-noise/README.md

# 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


### Usage
An example of usage of js-noise library with waku can be seen here: https://examples.waku.org/noise-js/
The code for this example is available in the [js-waku-examples repository](https://github.com/waku-org/js-waku-examples/tree/master/examples/noise-js) repository
You can also refer to the test units available within this repository (`*.spec.ts`) for more examples on usage.

## 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.