Update README.md
This commit is contained in:
parent
89b5fb9cf1
commit
6c1aa0fd29
26
README.md
26
README.md
|
|
@ -11,17 +11,41 @@ The Hash of Wisdom server requires clients to solve computational puzzles (proof
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
- Go 1.24.3+
|
- Go 1.24.3+
|
||||||
- Docker (optional)
|
- Docker (optional)
|
||||||
|
- [Task](https://taskfile.dev/) (optional, but recommended)
|
||||||
|
|
||||||
### Building
|
### Building
|
||||||
```bash
|
```bash
|
||||||
# Build server
|
# Build server
|
||||||
go build -o hash-of-wisdom ./cmd/server
|
go build -o hash-of-wisdom ./cmd/server
|
||||||
|
|
||||||
# Build client
|
# Build client
|
||||||
go build -o client ./cmd/client
|
go build -o client ./cmd/client
|
||||||
```
|
```
|
||||||
|
|
||||||
### Running
|
### 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
|
```bash
|
||||||
# Start server (uses config.yaml by default)
|
# Start server (uses config.yaml by default)
|
||||||
./hash-of-wisdom
|
./hash-of-wisdom
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue