status-im
/
js-waku
mirror of https://github.com/status-im/js-waku.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
js-waku/README.md

55 lines
1.9 KiB
Markdown
Raw Normal View History

Add badges Allows user to quickly access npm page and Discord.
2021-08-20 00:51:34 +00:00
[![NPM](https://nodei.co/npm/js-waku.png)](https://npmjs.org/package/js-waku)
![GitHub Action](https://img.shields.io/github/workflow/status/status-im/js-waku/CI)
[![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ)
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
Add documentation to the readme
2021-05-12 03:18:37 +00:00
A JavaScript 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
Remove inline doc Point to docs.dappconnect.dev instead.
2021-12-02 04:28:07 +00:00
- [Quick start](https://docs.dappconnect.dev/docs/quick_start/)
- [Full documentation](https://docs.dappconnect.dev/)
- [API documentation (`main` branch)](https://status-im.github.io/js-waku/docs/)
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
Remove inline doc Point to docs.dappconnect.dev instead.
2021-12-02 04:28:07 +00:00
git clone https://github.com/status-im/js-waku.git
cd js-waku
Point to guide menu and remove example section
2021-08-02 04:29:54 +00:00
npm install
npm run doc
```
Add link to release changelog
2021-05-15 10:59:52 +00:00
## Changelog
Remove inline doc Point to docs.dappconnect.dev instead.
2021-12-02 04:28:07 +00:00
Release changelog can be found in [CHANGELOG.md](https://github.com/status-im/js-waku/blob/main/CHANGELOG.md).
Add link to release changelog
2021-05-15 10:59:52 +00:00
Move protocol support after examples
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/).
Remove inline doc Point to docs.dappconnect.dev instead.
2021-12-02 04:28:07 +00:00
To get help, join **#dappconnect-support** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or [Telegram](https://t.me/dappconnectsupport).
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
For more general discussion and latest news, join **#dappconnect** on [Vac Discord](https://discord.gg/9DgykdmpZ6) or [Telegram](https://t.me/dappconnect).
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
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
You can track progress on the [project board](https://github.com/status-im/js-waku/projects/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
Remove inline doc Point to docs.dappconnect.dev instead.
2021-12-02 04:28:07 +00:00
See [CONTRIBUTING.md](https://github.com/status-im/js-waku/blob/main/CONTRIBUTING.md).
Apply MIT or Apache V2.0 License
2021-04-28 06:29:43 +00:00
## License
Licensed and distributed under either of
* MIT license: [LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT
or
* Apache License, Version 2.0, ([LICENSE-APACHE-v2](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.