zeldon
/
mineping
mirror of https://github.com/minescope/mineping.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(README.md): improve clarity and grammar in the project description

This commit is contained in:
Timofey Gelazoniya 2023-10-22 22:49:53 +03:00
parent 0aa73655b1
commit 9dace3748b
Signed by: zeldon
GPG Key ID: 047886915281DD2A
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -1,6 +1,6 @@
# mineping
`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.
This JavaScript library provides an implementation of the Minecraft server ping protocol. **It allows you to gather information about a Minecraft server**, such as the MOTD, current online players, server icon (Java Edition only), and more.
Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center" width="20" height="20"/> Git](https://git.zeldon.ru/zeldon/mineping)
@ -10,6 +10,8 @@ Mirror on my [<img src="https://git.zeldon.ru/assets/img/logo.svg" align="center
## Install
To install `mineping`, simply run the following command:
```
npm i @minescope/mineping
```
@ -17,6 +19,7 @@ npm i @minescope/mineping
## 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';
@ -59,5 +62,7 @@ console.log(data);
## Acknowledgements
Special thanks to the following projects:
- [mcping](https://github.com/Scetch/mcping) crate for Rust
- [mcping-js](https://github.com/Cryptkeeper/mcping-js) library for quering Minecraft Java Edition servers