diff --git a/README.md b/README.md index 799f7df..34e0cbd 100644 --- a/README.md +++ b/README.md @@ -27,10 +27,10 @@ The wiki has been completely reworked and is now available on [readthedocs.io](h ## Quick start - To start the server, execute `python3 pykms_Server.py [IPADDRESS] [PORT]`, the default _IPADDRESS_ is `::` ( all interfaces ) and the default _PORT_ is `1688`. - - Note that both the address and port are optional. - - It's allowed to use IPv4 and IPv6 addresses. - - If you have an IPv6-capable dual-stack OS, a dual-stack socket is created when using a IPv6 address. - - **[In case your OS does not support IPv6](https://github.com/Py-KMS-Organization/py-kms/issues/108), make sure to explicitly specify the legacy IPv4 of `0.0.0.0`!** + - Note that both the address and port are optional. + - It's allowed to use IPv4 and IPv6 addresses. + - If you have an IPv6-capable dual-stack OS, a dual-stack socket is created when using a IPv6 address. + - **[In case your OS does not support IPv6](https://github.com/Py-KMS-Organization/py-kms/issues/108), make sure to explicitly specify the legacy IPv4 of `0.0.0.0`!** - To start the server automatically using Docker, execute `docker run -d --name py-kms --restart always -p 1688:1688 ghcr.io/py-kms-organization/py-kms`. - To show the help pages type: `python3 pykms_Server.py -h` and `python3 pykms_Client.py -h`.