zeldon/mineping
1
0
Fork 0
mirror of https://github.com/minescope/mineping.git synced 2025-06-18 03:16:17 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: add guide how to install beta version

Browse Source
This commit is contained in:
Timofey Gelazoniya 2025-06-16 03:39:21 +03:00
parent 3c2c049c19
commit 51b4771305
Signed by: zeldon
GPG Key ID: D99707D1FF69FAB0
1 changed files with 14 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -16,13 +16,16 @@ To install `mineping`, simply run the following command:
npm i @minescope/mineping
```
> To install _beta_ version (if available), run: `npm i @minescope/mineping@next`
## Loading and configuration the module
### ES Modules (ESM)
If you are using ES Modules, you can import the library like this:
```js
import { pingJava, pingBedrock } from '@minescope/mineping';
import { pingJava, pingBedrock } from "@minescope/mineping";
```
### CommonJS
@ -31,8 +34,10 @@ import { pingJava, pingBedrock } from '@minescope/mineping';
If you cannot switch to ESM, you can use the async `import()` function from CommonJS to load `mineping` asynchronously:
```js
const pingJava = (...args) => import('@minescope/mineping').then(module => module.pingJava(...args));
const pingBedrock = (...args) => import('@minescope/mineping').then(module => module.pingBedrock(...args));
const pingJava = (...args) =>
import("@minescope/mineping").then((module) => module.pingJava(...args));
const pingBedrock = (...args) =>
import("@minescope/mineping").then((module) => module.pingBedrock(...args));
```
## Usage
@ -40,20 +45,20 @@ const pingBedrock = (...args) => import('@minescope/mineping').then(module => mo
Ping a Java server with default options:
```js
import { pingJava } from '@minescope/mineping';
import { pingJava } from "@minescope/mineping";
const data = await pingJava('mc.hypixel.net');
const data = await pingJava("mc.hypixel.net");
console.log(data);
```
Ping a Bedrock server with custom options:
```js
import { pingBedrock } from '@minescope/mineping';
import { pingBedrock } from "@minescope/mineping";
const data = await pingBedrock('mco.mineplex.com', {
port: 19132,
timeout: 500
const data = await pingBedrock("mco.mineplex.com", {
port: 19132,
timeout: 500,
});
console.log(data);
```