mirror of https://github.com/waku-org/js-noise.git
Browser library using Noise Protocols for Waku Payload Encryption https://rfc.vac.dev/spec/35/
2ec5928aed
|
||
|---|---|---|
| .github/workflows | ||
| example | ||
| src | ||
| .cspell.json | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitignore | ||
| .mocharc.json | ||
| .prettierrc | ||
| .size-limit.cjs | ||
| LICENSE-APACHE-v2 | ||
| LICENSE-MIT | ||
| README.md | ||
| bors.toml | ||
| buf.gen.yaml | ||
| buf.yaml | ||
| karma.conf.cjs | ||
| package-lock.json | ||
| package.json | ||
| rollup.config.js | ||
| tsconfig.dev.json | ||
| tsconfig.json | ||
| tsconfig.karma.json | ||
| typedoc.json | ||
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
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.
For more general discussion, help and latest news, join Vac Discord or Telegram.
License
Licensed and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- Apache License, Version 2.0, (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.