Update README.md
This commit is contained in:
parent
89b5fb9cf1
commit
6c1aa0fd29
24
README.md
24
README.md
|
|
@ -11,6 +11,7 @@ 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
|
||||
|
|
@ -22,6 +23,29 @@ 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
|
||||
|
|
|
|||
Loading…
Reference in a new issue