Update README.md with addr and local flags
This commit is contained in:
parent
d6d0f36cee
commit
2a0f9348e9
19
README.md
19
README.md
@ -47,13 +47,22 @@ go run main.go
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Server connection settings can be modified in `types/types.go`:
|
Server connection can be configured using command-line flags:
|
||||||
```go
|
|
||||||
const (
|
```bash
|
||||||
ServerAddr = "boner.be:6969" // Change this to connect to a different server or localhost if you want to run the server locally for development
|
# Connect to default server (boner.be:6969)
|
||||||
)
|
go run main.go
|
||||||
|
|
||||||
|
# Connect to local server
|
||||||
|
go run main.go -local
|
||||||
|
|
||||||
|
# Connect to specific server
|
||||||
|
go run main.go -addr somehost # Uses somehost:6969
|
||||||
|
go run main.go -addr somehost:6970 # Uses somehost:6970
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Note: The `-local` flag is a shorthand for `-addr localhost:6969` and cannot be used together with `-addr`.
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
The project uses Protocol Buffers for network communication. If you modify the `.proto` files, regenerate the Go code with:
|
The project uses Protocol Buffers for network communication. If you modify the `.proto` files, regenerate the Go code with:
|
||||||
|
Loading…
x
Reference in New Issue
Block a user