js-waku/README.md

51 lines
1.8 KiB
Markdown
Raw Permalink Normal View History

![GitHub Action](https://img.shields.io/github/actions/workflow/status/waku-org/js-waku/ci.yml?branch=master)
![Code Climate](https://img.shields.io/codeclimate/maintainability/waku-org/js-waku)
2023-07-11 16:47:19 +00:00
[![Discord chat](https://img.shields.io/discord/1110799176264056863.svg?logo=discord&colorB=7289DA)](https://discord.waku.org)
# js-waku
2022-10-31 01:20:52 +00:00
A TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).
2021-03-15 03:35:10 +00:00
## Documentation
- [Quick start](https://docs.waku.org/guides/js-waku/#getting-started)
2023-07-11 16:47:19 +00:00
- [Full documentation](https://docs.waku.org/guides/js-waku)
- [API documentation (`master` branch)](https://js.waku.org/)
2023-02-28 04:30:16 +00:00
- [Waku](https://waku.org/)
- [Vac](https://vac.dev/)
API Documentation can also be generated locally:
```shell
2022-10-31 01:20:52 +00:00
git clone https://github.com/waku-org/js-waku.git
cd js-waku
npm install
npm run doc
```
2021-07-30 05:31:59 +00:00
## Bugs, Questions & Features
2022-10-31 01:20:52 +00:00
If you encounter any bug or would like to propose new features, feel free to [open an issue](https://github.com/waku-org/js-waku/issues/new/).
2021-07-30 05:31:59 +00:00
2023-02-28 04:30:16 +00:00
For general discussion, get help or latest news, join us on [Vac Discord](https://discord.gg/Nrac59MfSX) or the [Waku Telegram Group](https://t.me/waku_org).
2021-07-30 05:31:59 +00:00
## Roadmap
2022-10-31 01:20:52 +00:00
You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1).
## Contributing
2022-10-31 01:20:52 +00:00
See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md).
2021-04-28 06:29:43 +00:00
## License
2022-10-31 01:20:52 +00:00
2021-04-28 06:29:43 +00:00
Licensed and distributed under either of
2022-10-31 01:20:52 +00:00
- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT
2021-04-28 06:29:43 +00:00
or
2022-10-31 01:20:52 +00:00
- Apache License, Version 2.0, ([LICENSE-APACHE-v2](https://github.com/waku-org/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.