diff --git a/README.md b/README.md index 4c1483c..2c64838 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # nwaku-compose -Ready to use docker-compose to run your own [nwaku](https://github.com/waku-org/nwaku) full node. Features: +Ready to use docker-compose to run your own [nwaku](https://github.com/waku-org/nwaku) full node. Description: * nwaku node running relay and store protocols with RLN enabled. -* simple frontend to interact with your node and the network, to publish and receive messages. -* grafana dashboard for advances users or node operators. +* Simple frontend to interact with your node and the network, to publish and receive messages. +* Grafana dashboard for advanced users or node operators. +* Requires `docker-compose` and `git`. -You need `docker-compose` and `git`. - -Get the code: +**1. Get the code:** ```console git clone git@github.com:waku-org/nwaku-compose.git cd nwaku-compose ``` +**2. Provide your Ethereum node** Waku needs an Ethereum Sepolia node, either yours or from a third party. Provide a websockets endpoint. You can get one for free from [Infura](https://www.infura.io/). ``` export ETH_CLIENT_ADDRESS=wss://sepolia.infura.io/ws/v3/USE_YOUR_INFURA_KEY_HERE @@ -23,17 +23,16 @@ Start everything. docker-compose up -d ``` -Your node is now connected to the network: -* See [localhost:4000](localhost:4000) to interact with your node -* See [localhost:3000](localhost:3000) for advanced metrics. - -If you just want to relay traffic in the network, you are all set. If you want to publish messages, you would need an RLN membership. For that you need: +**3. Register your RLN membership** +If you just want to relay traffic in the network, you are all set. But if you want to publish messages, you need an RLN membership. Its a simple onchain transaction, you need: * A wallet with some Sepolia Eth, <0.1 Eth. -* Go to [localhost:4000](localhost:4000) and `Register Credentials`. Set a `password`` and `Export` it as `keystore.json` -* In your nwaku node, set: +* Go to [localhost:4000](http://localhost:4000) and `Register Credentials`. Set a `password`` and `Export` it as `keystore.json` +* In your nwaku node, set. TODO: Improve manual process. * `rln-relay-cred-password` to the `password` you chose. * `rln-relay-cred-path` to `keystore.json` -**Note**: TODO: This last step of setting the keystore.json is quite manual. To be improved. +**4. Interact with your nwaku node** +* See [localhost:4000](http://localhost:4000) to interact with your node +* See [localhost:3000](http://localhost:3000) for advanced metrics. For advanced documentation, refer to [ADVANCED.md](https://github.com/waku-org/nwaku-compose/blob/master/ADVANCED.md). \ No newline at end of file