diff --git a/README.md b/README.md index 18fffc3..ab63d01 100644 --- a/README.md +++ b/README.md @@ -17,11 +17,34 @@ The Hash of Wisdom server requires clients to solve computational puzzles (proof # 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