From 6c1aa0fd2931bbcd33c560ee536650f0d15ce158 Mon Sep 17 00:00:00 2001 From: Savely Krendelhoff Date: Sat, 23 Aug 2025 18:53:40 +0700 Subject: [PATCH] Update README.md --- README.md | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 18fffc3..d55c4ac 100644 --- a/README.md +++ b/README.md @@ -11,17 +11,41 @@ The Hash of Wisdom server requires clients to solve computational puzzles (proof ### Prerequisites - Go 1.24.3+ - Docker (optional) +- [Task](https://taskfile.dev/) (optional, but recommended) ### Building ```bash # Build server go build -o hash-of-wisdom ./cmd/server -# Build client +# Build client go build -o client ./cmd/client ``` ### Running + +#### Using Task (Recommended) +```bash +# Most useful command - run all checks +task check + +# Start server +task server -- -config config.yaml + +# Connect client +task client -- --addr=localhost:8080 + +# Run tests +task test + +# See coverage +task test-coverage + +# See all available commands +task --list +``` + +#### Manual Commands ```bash # Start server (uses config.yaml by default) ./hash-of-wisdom