From 68faba24c19bfa63554d48a0773c074d9b0121fb Mon Sep 17 00:00:00 2001 From: Franck Royer Date: Mon, 21 Jun 2021 15:48:56 +1000 Subject: [PATCH] Move Eth-DM notes to root dir --- README.md | 23 +++++++++++++++++++++++ examples/eth-dm/README.md | 2 +- 2 files changed, 24 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 89a031d016..466776c045 100644 --- a/README.md +++ b/README.md @@ -191,6 +191,29 @@ You can also specify an optional `listenAddr` parameter (.e.g `--listenAddr /ip4 This is only useful if you want a remote node to dial to your chat app, it is not necessary in normal usage when you just connect to the fleet. +## Ethereum Direct Message + +A PoC implementation of [20/ETH-DM](https://rfc.vac.dev/spec/20/). + +Ethereum Direct Message, or Eth-DM, is a protocol that allows sending encrypted message to a recipient, +only knowing their Ethereum Address. + +This is protocol has been created to demonstrated how encryption and signature could be added to messages +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-dm/. + +To run a development version locally, do: + +```shell +git clone https://github.com/status-im/js-waku/ ; cd js-waku +npm install # Install dependencies for js-waku +npm run build # Build js-waku +cd examples/eth-dm +npm install # Install dependencies for the web app +npm run start # Start development server to serve the web app on http://localhost:3000/js-waku/eth-dm +``` + ## Contributing See [CONTRIBUTING.md](./CONTRIBUTING.md). diff --git a/examples/eth-dm/README.md b/examples/eth-dm/README.md index b2ec77babb..ff2fb69c5d 100644 --- a/examples/eth-dm/README.md +++ b/examples/eth-dm/README.md @@ -1,3 +1,3 @@ # Ethereum Direct Message Web App -A showcase app of [20/ETH-DM](https://rfc.vac.dev/spec/20/). +See js-waku [README](../../README.md#ethereum-direct-message) for details.