waku-org
/
js-waku
mirror of https://github.com/waku-org/js-waku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #161 from status-im/readme-update

This commit is contained in:
Franck Royer 2021-05-15 21:23:54 +10:00 committed by GitHub
parent 2bd74386cf 2f272634bc
commit e8fcc63e21
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -34,6 +34,19 @@ waku.addPeerToAddressBook(
);
```
You can also use `getStatusFleetNodes` to connect to nodes run by Status:
```javascript
import { getStatusFleetNodes } from 'js-waku';
const nodes = await getStatusFleetNodes();
await Promise.all(
nodes.map((addr) => {
return waku.dial(addr);
})
);
```
The `contentTopic` is a metadata `string` that allows categorization of messages on the waku network.
Depending on your use case, you can either create one (or several) new `contentTopic`(s) or look at the [RFCs](https://rfc.vac.dev/) and use an existing `contentTopic`.
See the [Waku v2 Message spec](https://rfc.vac.dev/spec/14/) for more details.
@ -91,6 +104,10 @@ npm install
npm run doc
```
## Changelog
Release changelog can be found [here](https://github.com/status-im/js-waku/blob/main/CHANGELOG.md).
## Waku Protocol Support
You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).
@ -119,7 +136,9 @@ You can track progress on the [project board](https://github.com/status-im/js-wa
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/).
For support, questions & more general topics, please join the discussion on the [Vac forum](https://forum.vac.dev/tag/js-waku) (use _\#js-waku_ tag).
For support, questions & more general topics,
please join the discussion on the [Vac forum](https://forum.vac.dev/tag/js-waku) (use _\#js-waku_ tag)
or [\#waku-support on Status Discord](https://discord.gg/VChNsDdj).
## Examples