mirror of https://github.com/waku-org/js-waku.git
JavaScript implementation of Waku v2
https://js.waku.org
ad15f861c3
Reasoning: by exposing the `Decoder` and `Encoder` classes to the user, the user may care about them, try to use the method etc. By "hiding" them away and providing `create*` help, the aim is for the user to just call a function instead of instantiating a class. Also, `V0` does not provide much information to the user so removing it. |
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| ci | ||
| nwaku@9debd44e2a | ||
| packages | ||
| .cspell.json | ||
| .editorconfig | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitmodules | ||
| .size-limit.cjs | ||
| CONTRIBUTING.md | ||
| LICENSE-APACHE-v2 | ||
| LICENSE-MIT | ||
| README.md | ||
| bors.toml | ||
| package-lock.json | ||
| package.json | ||
| tsconfig.dev.json | ||
| tsconfig.json | ||
| typedoc.json | ||
README.md
js-waku
A TypeScript implementation of the Waku v2 protocol.
Documentation
API Documentation can also be generated locally:
git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to open an issue.
For general discussion, get help or latest news, join #js-waku on Vac Discord or the Waku Telegram Group.
Roadmap
You can track progress on the project board.
Contributing
See CONTRIBUTING.md.
License
Licensed and distributed under either of
- MIT license: LICENSE-MIT or http://opensource.org/licenses/MIT
or
- Apache License, Version 2.0, (LICENSE-APACHE-v2 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.