mirror of https://github.com/waku-org/js-waku.git
Merge pull request #161 from status-im/readme-update
This commit is contained in:
commit
e8fcc63e21
21
README.md
21
README.md
|
@ -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.
|
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`.
|
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.
|
See the [Waku v2 Message spec](https://rfc.vac.dev/spec/14/) for more details.
|
||||||
|
@ -91,6 +104,10 @@ npm install
|
||||||
npm run doc
|
npm run doc
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
|
Release changelog can be found [here](https://github.com/status-im/js-waku/blob/main/CHANGELOG.md).
|
||||||
|
|
||||||
## 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).
|
||||||
|
@ -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/).
|
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
|
## Examples
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue