Update run instructions in README

This commit is contained in:
Maciej Krzyżanowski 2024-05-28 23:53:12 +02:00
parent 559a33eaa7
commit c95443f41f

View File

@ -6,13 +6,19 @@ Simple P2P server (and client - for testing purposes only, client for end user w
## Starting ## Starting
You can use these commands to start client and/or server: You can use these commands to start client and/or server:
``` ```bash
go run . client go run . --run client --waddr X.X.X.X:Y --uaddr X.X.X.X:Y
# for example:
go run . --run client --waddr krzyzanowski.dev:8080 --uaddr krzyzanowski.dev:8081
``` ```
Note that server should be started **before** running client. Note that server should be started **before** running client.
``` ```bash
go run . server go run . --run server --waddr X.X.X.X:Y --uaddr X.X.X.X:Y
# for example:
go run . --run server --waddr krzyzanowski.dev:8080 --uaddr krzyzanowski.dev:8081
``` ```
For now, address of server is hardcoded in client, and server starts on `localhost:8080`. `--waddr` and `--uaddr` options are optional, default values are respectively `:8080` and `:8081` (which is a short form of `localhost:8080` and `localhost:8081`)
`--run` option is mandatory and may take value of either `client` or `server`