@deitylamb/mcping 1.1.0 → 1.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -16
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,22 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Robust, and well-typed Minecraft server ping library for Node.js. Supports both **Java Edition** (1.7.x - 1.21+) and **Bedrock Edition**.
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
You can use the CLI to ping any server directly from your terminal:
|
|
8
|
-
|
|
9
|
-
```bash
|
|
10
|
-
# Using npx
|
|
11
|
-
npx @deitylamb/mcping mc.hypixel.net
|
|
12
|
-
|
|
13
|
-
# Options
|
|
14
|
-
npx @deitylamb/mcping mc.hypixel.net --timeout 1000
|
|
15
|
-
npx @deitylamb/mcping play.cubecraft.net --type bedrock
|
|
16
|
-
|
|
17
|
-
# Or install globally
|
|
18
|
-
npm install -g @deitylamb/mcping
|
|
19
|
-
mcping mc.hypixel.net
|
|
20
|
-
```
|
|
5
|
+
Also includes a [Modern CLI](#cli-usage) for quick server status checks directly from your terminal.
|
|
21
6
|
|
|
22
7
|
## Features
|
|
23
8
|
|
|
@@ -106,6 +91,23 @@ const res = await ping("example.com", {
|
|
|
106
91
|
}
|
|
107
92
|
```
|
|
108
93
|
|
|
94
|
+
## CLI Usage
|
|
95
|
+
|
|
96
|
+
The library includes a Neofetch-inspired command-line interface for quick status checks.
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
# Using npx
|
|
100
|
+
npx @deitylamb/mcping mc.hypixel.net
|
|
101
|
+
|
|
102
|
+
# Options
|
|
103
|
+
npx @deitylamb/mcping mc.hypixel.net --timeout 1000
|
|
104
|
+
npx @deitylamb/mcping play.cubecraft.net --type bedrock
|
|
105
|
+
|
|
106
|
+
# Or install globally
|
|
107
|
+
npm install -g @deitylamb/mcping
|
|
108
|
+
mcping mc.hypixel.net
|
|
109
|
+
```
|
|
110
|
+
|
|
109
111
|
## License
|
|
110
112
|
|
|
111
113
|
MIT © HarmoniaMC
|