From bce883a39ec58b289fd55b909d2415892d111b59 Mon Sep 17 00:00:00 2001 From: Sasha Date: Wed, 30 Aug 2023 01:10:11 +0200 Subject: [PATCH] update readme and texts --- examples/relay-chat/README.md | 20 +++++++++++++++----- examples/relay-chat/index.html | 2 +- examples/relay-chat/manifest.json | 4 ++-- 3 files changed, 18 insertions(+), 8 deletions(-) diff --git a/examples/relay-chat/README.md b/examples/relay-chat/README.md index ebc032a..397579b 100644 --- a/examples/relay-chat/README.md +++ b/examples/relay-chat/README.md @@ -1,13 +1,23 @@ -# Using Waku Light Push and Filter in JavaScript +# Using Waku Relay WebRTC **Demonstrates**: -- Waku Light node: Waku Filter + Waku Light Push +- Waku Relay node with direct WebRTC connection - Pure Javascript/HTML. -- Use minified bundle of js from unpkg.com, no import, no package manager. This example uses Waku Filter to listen to messages and Waku Light Push to send messages. -To test the example, simply download the `index.html` file from this folder and open it in a browser. +To test the example run `npm install` and then `npm start`. -The `master` branch's HEAD is deployed at https://examples.waku.org/light-js/. +The `master` branch's HEAD is deployed at https://examples.waku.org/relay-chat/. + +### Steps to run an example: +1. Build and then run `go-waku` node with following command: `./build/waku --ws true --relay true --circuit-relay true` +2. Copy node's multiaddr (e.g `/ip4/192.168.0.101/tcp/60001/ws/p2p/16Uiu2HAm9w2xeDWFJm5eeGLZfJdaPtkNatQD1xrzK5EFWSeXdFvu`) +3. In `relay-chat` example's folder run `npm install` and then `npm start` +4. Use `go-waku`'s multiaddr for **Remote node multiaddr** and press dial. Repeat in two more tabs. +5. In `tab2` copy **Local Peer Id** and use as **WebRTC Peer** in `tab1` and press dial. +6. In `tab1` or `tab2` press **Ensure WebRTC Relay connection** +7. In `tab1` press **Drop non WebRTC connections** +8. In `tab1` enter **Nickname** and **Message** and send. +9. See the message in `tab3` which was connected only to `go-waku` node. diff --git a/examples/relay-chat/index.html b/examples/relay-chat/index.html index 25b6de9..61a24f6 100644 --- a/examples/relay-chat/index.html +++ b/examples/relay-chat/index.html @@ -3,7 +3,7 @@ - JS-Waku light chat + JS-Waku WebRTC Relay diff --git a/examples/relay-chat/manifest.json b/examples/relay-chat/manifest.json index 4a01c8d..67c7c23 100644 --- a/examples/relay-chat/manifest.json +++ b/examples/relay-chat/manifest.json @@ -1,6 +1,6 @@ { - "name": "Light JS", - "description": "Send messages between several users (or just one) using light client targeted protocols.", + "name": "Waku Relay WebRTC JS", + "description": "Send messages between several users (or just one) using Relay with direct WebRTC connection.", "icons": [ { "src": "favicon.ico",