diff --git a/README.md b/README.md index 7a4d2e4..dfda842 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@ # mineping -Collect information about Minecraft (both Java and Bedrock) using **[Node.js](http://nodejs.org)**. - -## Description `mineping` is a Javasript library thar provides Minecraft server ping protocol implementation. It can be used to collect information about the server, such as MODT, current online, server icon (java edition only) and etc. +Mirror on my [ Git](https://git.zeldon.ru/zeldon/mineping) + ## Requirements + > **[Node.js](https://nodejs.org/) 14 or newer is required** ## Install @@ -23,6 +23,7 @@ import { pingJava, pingBedrock } from '@minescope/mineping'; ``` ### CommonJS + `mineping` is an ESM-only module — you are not able to import it with `require()`. If you cannot switch to ESM, you can use the async `import()` function from CommonJS to load `mineping` asynchronously: @@ -53,8 +54,10 @@ const data = await pingBedrock('mco.mineplex.com', { }); console.log(data); ``` + > More complex example can be found in the `example` folder! ## Acknowledgements + - [mcping](https://github.com/Scetch/mcping) crate for Rust -- [mcping-js](https://github.com/Cryptkeeper/mcping-js) library for quering Minecraft Java Edition servers \ No newline at end of file +- [mcping-js](https://github.com/Cryptkeeper/mcping-js) library for quering Minecraft Java Edition servers