js-waku/README.md

![GitHub Action](https://img.shields.io/github/actions/workflow/status/waku-org/js-waku/ci.yml?branch=master)
[![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/Nrac59MfSX)

# js-waku

A TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).

## Documentation

- [Quick start](https://js.waku.guide/docs/quick_start/)
- [Full documentation](https://js.waku.guide/)
- [API documentation (`master` branch)](https://js.waku.org/)
- [Waku](https://waku.org/)
- [Vac](https://vac.dev/)

API Documentation can also be generated locally:

```shell
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](https://github.com/waku-org/js-waku/issues/new/).

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

## Roadmap

You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1).

## Contributing

See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md).

## License

Licensed and distributed under either of

- MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT

or

- 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)

at your option. These files may not be copied, modified, or distributed except according to those terms.
chore: fix build badge Ref: https://github.com/badges/shields/issues/8671 2023-03-14 03:34:38 +00:00			`![GitHub Action](https://img.shields.io/github/actions/workflow/status/waku-org/js-waku/ci.yml?branch=master)`
chore: fix Discord invite link 2023-03-14 03:35:46 +00:00			`[![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/Nrac59MfSX)`
Add badges Allows user to quickly access npm page and Discord. 2021-08-20 00:51:34 +00:00
Revert naming to js-waku To align with go-waku and nim-waku and keep bors working. 2021-05-13 06:49:29 +00:00			`# js-waku`
Initial commit Created with bitjson/typescript-starter@586cdb3029ab2c52e2f0893adafbbb017059e1c9 2021-03-04 22:34:01 +00:00
doc: update readmes 2022-10-31 01:20:52 +00:00			`A TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).`
Update readme 2021-03-15 03:35:10 +00:00
Point to guide menu and remove example section 2021-08-02 04:29:54 +00:00			`## Documentation`

doc: update links 2023-02-28 04:30:16 +00:00			`- [Quick start](https://js.waku.guide/docs/quick_start/)`
			`- [Full documentation](https://js.waku.guide/)`
ci: update site domain to js.waku.org Resolves: https://github.com/waku-org/js-waku/issues/943 Signed-off-by: Jakub Sokołowski <jakub@status.im> 2022-09-09 15:58:16 +00:00			- [API documentation (`master` branch)](https://js.waku.org/)
doc: update links 2023-02-28 04:30:16 +00:00			`- [Waku](https://waku.org/)`
Rename DappConnect to Waku Connect (#427) 2022-01-24 04:00:11 +00:00			`- [Vac](https://vac.dev/)`
Point to guide menu and remove example section 2021-08-02 04:29:54 +00:00
Remove inline doc Point to docs.dappconnect.dev instead. 2021-12-02 04:28:07 +00:00			`API Documentation can also be generated locally:`
Point to guide menu and remove example section 2021-08-02 04:29:54 +00:00
			```shell
doc: update readmes 2022-10-31 01:20:52 +00:00			`git clone https://github.com/waku-org/js-waku.git`
Remove inline doc Point to docs.dappconnect.dev instead. 2021-12-02 04:28:07 +00:00			`cd js-waku`
Point to guide menu and remove example section 2021-08-02 04:29:54 +00:00			`npm install`
			`npm run doc`
			```

Move protocol support after examples 2021-07-30 05:31:59 +00:00			`## Bugs, Questions & Features`

doc: update readmes 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/).`
Move protocol support after examples 2021-07-30 05:31:59 +00:00
doc: update links 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).`
Move protocol support after examples 2021-07-30 05:31:59 +00:00
Remove inline doc Point to docs.dappconnect.dev instead. 2021-12-02 04:28:07 +00:00			`## Roadmap`
Provide status on waku protocol support 2021-04-09 01:55:41 +00:00
doc: update readmes 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).`
Update readme to point developers to right forums 2021-04-13 00:56:13 +00:00
Make testing in CI possible By adding nim-waku as a submodule and building it as part of the tests. 2021-03-15 05:22:26 +00:00			`## Contributing`

doc: update readmes 2022-10-31 01:20:52 +00:00			`See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md).`
Apply MIT or Apache V2.0 License 2021-04-28 06:29:43 +00:00
			`## License`
doc: update readmes 2022-10-31 01:20:52 +00:00
Apply MIT or Apache V2.0 License 2021-04-28 06:29:43 +00:00			`Licensed and distributed under either of`

doc: update readmes 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`
Apply MIT or Apache V2.0 License 2021-04-28 06:29:43 +00:00
			`or`

doc: update readmes 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)`
Apply MIT or Apache V2.0 License 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.`