2021-08-20 00:51:34 +00:00
[](https://npmjs.org/package/js-waku)
[](https://discord.gg/j5pGbn7MHZ)
2021-05-13 06:49:29 +00:00
# js-waku
2021-03-04 22:34:01 +00:00
2021-05-12 03:18:37 +00:00
A JavaScript implementation of the [Waku v2 protocol ](https://rfc.vac.dev/spec/10/ ).
2021-03-15 03:35:10 +00:00
2021-08-02 04:29:54 +00:00
## Documentation
2022-01-24 04:00:11 +00:00
- [Quick start ](https://docs.wakuconnect.dev/docs/quick_start/ )
- [Full documentation ](https://docs.wakuconnect.dev/ )
2022-01-27 01:40:46 +00:00
- [API documentation (`master` branch) ](https://js-waku.wakuconnect.dev/ )
2022-01-24 04:00:11 +00:00
- [Waku Connect ](https://wakuconnect.dev/ )
- [Waku ](https://wakunetwork.com/ )
- [Vac ](https://vac.dev/ )
2021-08-02 04:29:54 +00:00
2021-12-02 04:28:07 +00:00
API Documentation can also be generated locally:
2021-08-02 04:29:54 +00:00
```shell
2021-12-02 04:28:07 +00:00
git clone https://github.com/status-im/js-waku.git
cd js-waku
2021-08-02 04:29:54 +00:00
npm install
npm run doc
```
2021-05-15 10:59:52 +00:00
## Changelog
2022-01-04 22:07:57 +00:00
Release changelog can be found in [CHANGELOG.md ](https://github.com/status-im/js-waku/blob/master/CHANGELOG.md ).
2021-05-15 10:59:52 +00:00
2021-07-30 05:31:59 +00:00
## Bugs, Questions & Features
If you encounter any bug or would like to propose new features, feel free to [open an issue ](https://github.com/status-im/js-waku/issues/new/ ).
2022-01-24 04:00:11 +00:00
To get help, join ** #wakuconnect -support** on [Vac Discord ](https://discord.gg/j5pGbn7MHZ ) or [Telegram ](https://t.me/wakuconnectsupport ).
2021-07-30 05:31:59 +00:00
2022-01-24 04:00:11 +00:00
For more general discussion and latest news, join ** #wakuconnect ** on [Vac Discord ](https://discord.gg/9DgykdmpZ6 ) or [Telegram ](https://t.me/wakuconnect ).
2021-07-30 05:31:59 +00:00
2021-12-02 04:28:07 +00:00
## Roadmap
2021-04-09 01:55:41 +00:00
2021-05-13 06:49:29 +00:00
You can track progress on the [project board ](https://github.com/status-im/js-waku/projects/1 ).
2021-04-13 00:56:13 +00:00
2021-03-15 05:22:26 +00:00
## Contributing
2022-01-04 22:07:57 +00:00
See [CONTRIBUTING.md ](https://github.com/status-im/js-waku/blob/master/CONTRIBUTING.md ).
2021-04-28 06:29:43 +00:00
## License
Licensed and distributed under either of
2022-02-07 05:10:39 +00:00
* MIT license: [LICENSE-MIT ](https://github.com/status-im/js-waku/blob/master/LICENSE-MIT ) or http://opensource.org/licenses/MIT
2021-04-28 06:29:43 +00:00
or
2022-02-07 05:10:39 +00:00
* Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/status-im/js-waku/blob/master/LICENSE-APACHE-v2) or http://www.apache.org/licenses/LICENSE-2.0)
2021-04-28 06:29:43 +00:00
at your option. These files may not be copied, modified, or distributed except according to those terms.
