diff --git a/README.md b/README.md
index fcd7af6..788849d 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,7 @@
-A modern, small, performant, zero dependency TypeScript library made for fast pinging and getting status of Minecraft servers
+A modern, small, fast, performant, zero dependency TypeScript library made for pinging and getting status of Minecraft servers.
@@ -66,31 +66,31 @@ console.log(result);
* `host:` string
> Either an IP, or a hostname of the server. (alias: hostname)
* `port?:` number `default: 25565`
- > Port of the server. Any port other than 25565 disables SRV lookup.
+ > Port of the server. SRV lookup is disabled when using ports other than 25565.
* `timeout?:` number `default: 10000`
- > Timeout of when an error is thrown after no response. Default is 10 seconds.
+ > How long until an error is thrown if the transaction still hasn't finished. Default is 10 seconds.
* `ping?:` boolean `default: true`
- > Whether to send a payload at the end to get the latency of the server. If false, the `latency` field will be null.
+ > Whether to send a payload at the end to measure the server latency. If false, the `latency` field will be null.
* `protocolVersion?:` number `default: 764`
> Protocol version to send to the server to simulate different Minecraft client versions. Here, you can see the [Protocol Version Numbers](https://wiki.vg/Protocol_version_numbers). The current default protocol version is for 1.20.2 (764) and will be irregularly updated to newer versions.
* `throwOnParseError?:` boolean `default: true`
- > Whether to throw an error if the status packet fails to parse the status field. The `statusRaw` field is always included.
+ > Whether to throw an error if the status packet fails to parse the status field. The `statusRaw` field is always included.
* `disableSrv?:` boolean `default: false`
- > Whether to force skip SRV lookups. Useful when only pinging IP addresses and not hostnames.
+ > Whether to force skip SRV lookups. Useful when only pinging IP addresses and not hostnames (domains).
* `disableJSONParse?:` boolean `default: false`
- > Whether to skip JSON parsing. Useful if you only want the raw text response. If true, the `status` field to be undefined.
+ > Whether to skip JSON parsing. Useful if you only want a raw plaintext response. If true, the `status` field will be undefined.
* ServerStatus
* `latency?:` number
- > The time it takes to send and receive a payload from the server. Will be null if `ping` option is false.
+ > The time it takes to receive back a response after sending a small payload to a server, in milliseconds. Will be null if the `ping` option is false.
* `status?:` DynamicObject
- > Parsed status response from the sever. Will be null if the status fails to parse, or if disableJSONParse is true. Example of a valid Status Response.
+ > Parsed status response from the server. Will be null if the status fails to parse, or if disableJSONParse is true. Example of a valid Status Response.
* `statusRaw:` string
- > Raw status response in the form of a string. Useful when `status` fails to parse.
+ > Plaintext status response in the form of JSON. Useful when `status` fails to parse.
* .setDnsServers(): `((serverArray: string[]) => Promise)`
- > It wraps the `dns.setServers` function, ueful when you want to look up the SRV records with different DNS servers.
- The first IP in the array is always the main DNS server, others are backup servers.
- Pass in a parameter which is an array of hostnames or IP addresses of DNS servers. It will either return true, or throw an error.
+ > It wraps the `dns.setServers` function, useful for looking up SRV records through different DNS servers.
+ The first IP in the array will always be used first, others will be tried if the first one is unreachable.
+ Accepts an array of hostnames or IP addresses of DNS servers. It will either return true, or throw an error.
Usage:
@@ -98,15 +98,15 @@ console.log(result);
// For example:
mc.setDnsServers(["9.9.9.9", "1.1.1.1", "8.8.8.8"])
// (Quad9, Cloudflare, Google)
- // Cloudflare is the fastest for DNS queries in most of the world.
+ // Cloudflare is usually the fastest for DNS queries.
```
If you never changed the DNS settings of your computer, the default DNS server will be your ISP's.
- ❗ I recommend changing your default DNS servers if you're doing thousands of lookups, for better performance.
+ ❗ I recommend changing your default DNS servers if you're doing thousands of lookups, such as for mass scanning.
### Changelog
**[View Changelog](https://pinger.floppa.hair/changelog/)**,
- Latest version: v1.1.4
+ Latest version: v1.1.4
