waku-org/js-waku
1
0
Fork 0
mirror of https://github.com/waku-org/js-waku.git synced 2025-01-24 03:09:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update readmes

Browse Source
This commit is contained in:
fryorcraken.eth 2022-10-31 12:20:52 +11:00
parent 88a3c2adf0
commit fe0a3d938f
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
2 changed files with 65 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -1,11 +1,9 @@
[![NPM](https://nodei.co/npm/js-waku.png)](https://npmjs.org/package/js-waku) ![GitHub Action](https://img.shields.io/github/workflow/status/waku-org/js-waku/CI)
![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) [![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ)
# js-waku # js-waku
A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/). A TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).
## Documentation ## Documentation
@ -19,37 +17,34 @@ A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/1
API Documentation can also be generated locally: API Documentation can also be generated locally:
```shell ```shell
git clone https://github.com/status-im/js-waku.git git clone https://github.com/waku-org/js-waku.git
cd js-waku cd js-waku
npm install npm install
npm run doc npm run doc
``` ```
## Changelog
Release changelog can be found in [CHANGELOG.md](https://github.com/status-im/js-waku/blob/master/CHANGELOG.md).
## Bugs, Questions & Features ## 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/). 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 **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or the [Waku Telegram Group](https://t.me/waku_org). For general discussion, get help or latest news, join **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) or the [Waku Telegram Group](https://t.me/waku_org).
## Roadmap ## Roadmap
You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1). You can track progress on the [project board](https://github.com/orgs/waku-org/projects/2/views/1).
## Contributing ## Contributing
See [CONTRIBUTING.md](https://github.com/status-im/js-waku/blob/master/CONTRIBUTING.md). See [CONTRIBUTING.md](https://github.com/waku-org/js-waku/blob/master/CONTRIBUTING.md).
## License ## License
Licensed and distributed under either of Licensed and distributed under either of
* MIT license: [LICENSE-MIT](https://github.com/status-im/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT - MIT license: [LICENSE-MIT](https://github.com/waku-org/js-waku/blob/master/LICENSE-MIT) or http://opensource.org/licenses/MIT
or or
* 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) - 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. at your option. These files may not be copied, modified, or distributed except according to those terms.

56
packages/core/README.md Normal file
View File

@ -0,0 +1,56 @@
[![NPM](https://nodei.co/npm/@waku/core.png)](https://npmjs.org/package/@waku/core)
![GitHub Action](https://img.shields.io/github/workflow/status/waku-org/js-waku/CI)
[![Discord chat](https://img.shields.io/discord/864066763682218004.svg?logo=discord&colorB=7289DA)](https://discord.gg/j5pGbn7MHZ)
# @waku/core
Core components of js-waku, a TypeScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).
## Documentation
- [Quick start](https://docs.wakuconnect.dev/docs/quick_start/)
- [Full documentation](https://docs.wakuconnect.dev/)
- [API documentation (`master` branch)](https://js.waku.org/)
- [Waku Connect](https://wakuconnect.dev/)
- [Waku](https://wakunetwork.com/)
- [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
```
## Changelog
Release changelog can be found in [CHANGELOG.md](https://github.com/waku-org/js-waku/blob/master/packages/core/CHANGELOG.md).
## 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 **#js-waku** on [Vac Discord](https://discord.gg/j5pGbn7MHZ) 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.