mirror of
https://github.com/logos-messaging/logos-delivery-compose.git
synced 2026-06-07 20:59:28 +00:00
fix: update readme.md and according to new guidelines
This commit is contained in:
parent
a9f6fb7eaa
commit
b48a207dfa
33
README.md
33
README.md
@ -18,25 +18,11 @@ Ready‑to‑use **docker‑compose** stack for running your own [nwaku](https:/
|
|||||||
|
|
||||||
| # | Option | Quick-start command | What happens |
|
| # | Option | Quick-start command | What happens |
|
||||||
|---|------|--------------------|--------------|
|
|---|------|--------------------|--------------|
|
||||||
| **1** | **setup-wizard** | Fastest one-command bootstrap | Generates `.env`, registers RLN, and spins up the whole stack automatically |
|
| **1** | **script** | Power user / CI | setup a .env file manually, run ./register_rln.sh, and then start the node.|
|
||||||
| **2** | **script** | Power user / CI | setup a .env file manually, run ./register_rln.sh, and then start the node.|
|
| **2** | **setup-wizard** | Fastest one-command bootstrap | Generates `.env`, registers RLN, and spins up the whole stack automatically |
|
||||||
|
|
||||||
<details>
|
<details>
|
||||||
<summary>⚙️ option 1 :- SETUP-WIZARD [ experimental ]</summary>
|
<summary>🧪 option 1 :- SCRIPT [ manual ] [ recommended ] </summary>
|
||||||
|
|
||||||
Run the wizard script.
|
|
||||||
Once the script is done, the node will be started for you, so there is nothing else to do.
|
|
||||||
|
|
||||||
The script is experimental, feedback and pull requests are welcome.
|
|
||||||
|
|
||||||
```
|
|
||||||
./setup_wizard.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
</details>
|
|
||||||
|
|
||||||
<details>
|
|
||||||
<summary>🧪 option 2 :- SCRIPT [ manual ] [ recommended ] </summary>
|
|
||||||
|
|
||||||
```
|
```
|
||||||
cp .env.example .env
|
cp .env.example .env
|
||||||
@ -118,6 +104,19 @@ For advanced documentation, refer to [ADVANCED.md](https://github.com/waku-org/n
|
|||||||
|
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
|
<details>
|
||||||
|
<summary>⚙️ option 1 :- SETUP-WIZARD [ experimental ]</summary>
|
||||||
|
|
||||||
|
Run the wizard script.
|
||||||
|
Once the script is done, the node will be started for you, so there is nothing else to do.
|
||||||
|
|
||||||
|
The script is experimental, feedback and pull requests are welcome.
|
||||||
|
|
||||||
|
```
|
||||||
|
./setup_wizard.sh
|
||||||
|
```
|
||||||
|
|
||||||
|
</details>
|
||||||
|
|
||||||
### 📌 Note
|
### 📌 Note
|
||||||
RLN membership is your access key to The Waku Network. It is registered on-chain, enabling your nwaku node to send messages in a decentralized and privacy-preserving way while adhering to rate limits. Messages exceeding the rate limit will not be relayed by other peers.
|
RLN membership is your access key to The Waku Network. It is registered on-chain, enabling your nwaku node to send messages in a decentralized and privacy-preserving way while adhering to rate limits. Messages exceeding the rate limit will not be relayed by other peers.
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user