diff --git a/README.md b/README.md index d1d506a1a..6e74a878a 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ -# nim-waku +# Nwaku ## Introduction -The nim-waku repository implements Waku v1 and v2, and provides tools related to it. +The nwaku repository implements Waku v1 and v2, and provides tools related to it. - A Nim implementation of the [Waku v1 protocol](https://specs.vac.dev/waku/waku.html). - A Nim implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2.html). -- CLI applications `wakunode` and `wakunode2` that allows you to run a Waku v1 or v2 node. +- CLI applications `wakunode` and `wakunode2` that allow you to run a Waku v1 or v2 node. - Examples of Waku v1 and v2 usage. - Various tests of above. @@ -17,21 +17,17 @@ For more details on Waku v1 and v2, see their respective home folders: ## How to Build & Run -These instructions are generic and apply to both Waku v1 and v2. For more -detailed instructions, see Waku v1 and v2 home above. +These instructions are generic and apply to both Waku v1 and v2. For more detailed instructions, see Waku v1 and v2 home above. ### Prerequisites -* GNU Make, Bash and the usual POSIX utilities. Git 2.9.4 or newer. -* [Rust](https://www.rust-lang.org/) - -More information on the installation of these can be found [here](https://github.com/status-im/nimbus#prerequisites). +The standard developer tools, including a C compiler, GNU Make, Bash, and Git. More information on these installations can be found [here](https://docs.waku.org/guides/nwaku/build-source#install-dependencies). ### Wakunode ```bash # The first `make` invocation will update all Git submodules. -# You'll run `make update` after each `git pull`, in the future, to keep those submodules up to date. +# You'll run `make update` after each `git pull` in the future to keep those submodules updated. make wakunode1 wakunode2 # See available command line options @@ -40,9 +36,9 @@ make wakunode1 wakunode2 ``` For more on how to run `wakunode2`, refer to: -* [Run using binaries](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-1-run-nwaku-binary) -* [Run using docker](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-2-run-nwaku-in-a-docker-container) -* [Run using docker-compose](https://github.com/waku-org/nwaku/blob/master/docs/operators/quickstart.md#option-3-run-nwaku-with-docker-compose) +- [Run using binaries](https://docs.waku.org/guides/run-nwaku-node#download-the-binary) +- [Run using docker](https://docs.waku.org/guides/nwaku/run-docker) +- [Run using docker-compose](https://docs.waku.org/guides/nwaku/run-docker-compose) ### Waku Protocol Test Suite @@ -62,10 +58,10 @@ Different tools and their corresponding how-to guides can be found in the `tools ### Bugs, Questions & Features -For an inquiry, or if you would like to propose new features, feel free to [open a general issue](https://github.com/status-im/nim-waku/issues/new/). +For an inquiry, or if you would like to propose new features, feel free to [open a general issue](https://github.com/waku-org/nwaku/issues/new). -For bug reports, please [tag your issue with the `bug` label](https://github.com/status-im/nim-waku/issues/new/). +For bug reports, please [tag your issue with the `bug` label](https://github.com/waku-org/nwaku/issues/new). -If you believe the reported issue requires critical attention, please [use the `critical` label](https://github.com/status-im/nim-waku/issues/new?labels=critical,bug) to assist with triaging. +If you believe the reported issue requires critical attention, please [use the `critical` label](https://github.com/waku-org/nwaku/issues/new?labels=critical,bug) to assist with triaging. -To get help, or participate in the conversation, join the [Vac Discord](https://discord.gg/KNj3ctuZvZ) server. +To get help, or participate in the conversation, join the [Waku Discord](https://discord.waku.org/) server.