1
0
Fork 0

Update readme accordingly

Anton Smirnov 5 years ago
parent f6689a1c52
commit 5098937263

@ -1,15 +1,29 @@
Minecraft Server Query
======================
# Minecraft Server Query
[![Code Climate](https://img.shields.io/codeclimate/maintainability/sandfoxme/minecraft-query.svg?maxAge=2592000)](https://codeclimate.com/github/sandfoxme/minecraft-query)
A PHP library for checking the status of an enabled Minecraft server ported from python
[https://github.com/Dinnerbone/mcstatus](https://github.com/Dinnerbone/mcstatus)
Usage
-----
## Installation
Add the following code to your composer file.
```json
{
"require": {
"sandfoxme/bencode": "^1.0.2"
}
}
```
*NB:* 1.0.0 and 1.0.1 used the name `sandfox-im/bencode` and namespace `SandFoxIM\Minecraft`
## Usage
```php
<?php
$minecraft = new \SandFoxMe\Minecraft\ServerQuery($argv[1], $argv[2], 2);
echo "Basic info:\n";