diff --git a/README.md b/README.md index 3e014bf..464d5b1 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ Confused on how this works, or you want to see more? Checkout the [examples](/ex | **port** | number | Game port | Connection port or query port for the game server. Some games utilize a separate "query" port. If specifying the game port does not seem to work as expected, passing in this query port may work instead. | | **maxRetries** | number | 1 | Number of retries to query server in case of failure. Note that this amount multiplies with the number of attempts. | | **socketTimeout** | number | 2000 | Milliseconds to wait for a single packet. Beware that increasing this will cause many queries to take longer even if the server is online. | -| **attemptTimeout** | number | 10000 | Milliseconds allowed for an entire query attempt. This timeout is not commonly hit, as the socketTimeout typically fires first. | +| **attemptTimeout** | number | 10000 | Milliseconds allowed for an entire query attempt (including `socketTimeout`, beware that if this value is smaller (or even equal) to the socket one, the query will always fail). | | **givenPortOnly** | boolean | false | Only attempt to query server on given port. It will ignore the game's default port. | | **ipFamily** | number | 0 | IP family/version returned when looking up hostnames via DNS, can be 0 (IPv4 and IPv6), 4 (IPv4 only) or 6 (IPv6 only). | | **debug** | boolean | false | Enables massive amounts of debug logging to stdout. |