waku-org/js-waku
1
0
Fork 0
mirror of https://github.com/waku-org/js-waku.git synced 2025-02-02 23:53:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Point to guide menu and remove example section

Browse Source
This commit is contained in:
Franck Royer 2021-08-02 14:29:54 +10:00
parent 016ccd4836
commit bc71247acf
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -2,6 +2,23 @@
A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/). A JavaScript implementation of the [Waku v2 protocol](https://rfc.vac.dev/spec/10/).
## Documentation
In the [section below](#usage) you can find explanations for the main API.
We also have [guides](https://github.com/status-im/js-waku/blob/main/guides/menu.md) available
and [code examples](https://github.com/status-im/js-waku/blob/main/examples/examples.md).
You can read the latest `main` branch documentation at [https://status-im.github.io/js-waku/docs/](https://status-im.github.io/js-waku/docs/).
Docs can also be generated locally using:
```shell
npm install
npm run doc
```
## Usage ## Usage
Install `js-waku` package: Install `js-waku` package:
@ -249,18 +266,6 @@ const sigPubKey = wakuMessage.signaturePublicKey;
const isSignedByAlice = sigPubKey && equalByteArrays(sigPubKey, alicePublicKey); const isSignedByAlice = sigPubKey && equalByteArrays(sigPubKey, alicePublicKey);
``` ```
## More documentation
Find more [examples](#examples) below
or checkout the latest `main` branch documentation at [https://status-im.github.io/js-waku/docs/](https://status-im.github.io/js-waku/docs/).
Docs can also be generated locally using:
```shell
npm install
npm run doc
```
## Changelog ## Changelog
Release changelog can be found [here](https://github.com/status-im/js-waku/blob/main/CHANGELOG.md). Release changelog can be found [here](https://github.com/status-im/js-waku/blob/main/CHANGELOG.md).
@ -273,11 +278,6 @@ To get help, join #dappconnect-support on [Vac Discord](https://discord.gg/j5pGb
For more general discussion and latest news, join #dappconnect on [Vac Discord](https://discord.gg/9DgykdmpZ6) or [Telegram](https://t.me/dappconnect). For more general discussion and latest news, join #dappconnect on [Vac Discord](https://discord.gg/9DgykdmpZ6) or [Telegram](https://t.me/dappconnect).
## Examples
We have a number of code examples available,
you can find them in the [examples](https://github.com/status-im/js-waku/blob/main/examples/examples.md) directory.
## Waku Protocol Support ## Waku Protocol Support
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/status-im/js-waku/projects/1).