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

Examples are now deployed in wakuconnect.dev (#485)

This commit is contained in:
Franck R 2022-02-02 11:56:40 +11:00 committed by GitHub
parent e4888f779c
commit f2cf00bf44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
CHANGELOG.md
View File

@ -294,9 +294,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Add usage section to the README.
- Support of [Waku v2 Relay](https://rfc.vac.dev/spec/11/).
- Support of [Waku v2 Store](https://rfc.vac.dev/spec/13/).
- [Node Chat App example](./examples/cli-chat).
- [Node Chat App example]().
- [ReactJS Chat App example](./examples/web-chat).
- [Typedoc Documentation](https://status-im.github.io/js-waku/docs).
- [Typedoc Documentation](https://js-waku.wakuconnect.dev/).
[Unreleased]: https://github.com/status-im/js-waku/compare/v0.16.0...HEAD
[0.16.0]: https://github.com/status-im/js-waku/compare/v0.15.0...v0.16.0

2
CONTRIBUTING.md
View File

@ -26,7 +26,7 @@ To build and test this repository, you need:
To ensure interoperability with [nim-waku](https://github.com/status-im/nim-waku/), some tests are run against a nim-waku node.
This is why `nim-waku` is present as a [git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules), which itself contain several submodules.
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/js-waku/blob/main/package.json)).
At this stage, it is not possible to exclude nim-waku tests, hence `git submodule update --init --recursive` is run before testing (see [`pretest` script](https://github.com/status-im/js-waku/blob/master/package.json)).
To build nim-waku, you also need [Rust](https://www.rust-lang.org/tools/install).

4
examples/eth-pm-wallet-encryption/README.md
View File

@ -10,11 +10,13 @@
- Usage of [`eth_decrypt`](https://docs.metamask.io/guide/rpc-api.html#eth-decrypt) Wallet API
This dApp demonstrates how to send and received end-to-end encrypted messages
using the encryption API provided by some Web3 Wallet provider such as [Metamask](https://metamask.io/).
using the encryption API provided by some Web3 Wallet provider such as [MetaMask](https://metamask.io/).
The sender only needs to know the Ethereum address of the recipient.
The recipient must broadcast his encryption public key as a first step.
The `master` branch's HEAD is deployed on GitHub Pages at https://js-waku.wakuconnect.dev/examples/eth-pm-wallet-encryption/.
To run a development version locally, do:
```shell

2
examples/eth-pm/README.md
View File

@ -17,7 +17,7 @@ only knowing their Ethereum Address.
This protocol has been created to demonstrated how encryption and signature could be added to message
sent over the Waku v2 network.
The `main` branch's HEAD is deployed on GitHub Pages at https://status-im.github.io/js-waku/eth-pm/.
The `master` branch's HEAD is deployed on GitHub Pages at https://js-waku.wakuconnect.dev/examples/eth-pm/.
To run a development version locally, do:

2
examples/web-chat/README.md
View File

@ -9,7 +9,7 @@
A ReactJS chat app is provided as a showcase of the library used in the browser.
It implements [Waku v2 Toy Chat](https://rfc.vac.dev/spec/22/) protocol.
A deployed version is available at https://status-im.github.io/js-waku/.
A deployed version is available at https://js-waku.wakuconnect.dev/examples/web-chat/.
To run a development version locally, do: