From 081e7d44bd596831237a32159d02a45b91effd5d Mon Sep 17 00:00:00 2001 From: Michael Morrison Date: Wed, 10 Jul 2013 07:23:18 -0500 Subject: [PATCH] Add install instructions --- README.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3d6de79..31b2fdb 100644 --- a/README.md +++ b/README.md @@ -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