Add install instructions

This commit is contained in:
Michael Morrison 2013-07-10 07:23:18 -05:00
parent 27b09c37e4
commit 081e7d44bd

View file

@ -4,16 +4,22 @@ node-GameDig - Game Server Query Library
Usage
---
```bash
npm install gamedig
```
```javascript
var Gamedig = require('gamedig');
Gamedig.query({
type: 'minecraft',
host: 'mc.example.com',
callback: function(state) {
Gamedig.query(
{
type: 'minecraft',
host: 'mc.example.com'
},
function(state) {
if(state.error) console.log("Server is offline");
else console.log(state);
}
});
);
```
State Object