Robot
/
node-gamedig
mirror of https://github.com/gamedig/node-gamedig.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

clarify notes input

This commit is contained in:
Michael Morrison 2013-07-12 04:23:40 -05:00
parent d3e9e818f1
commit f73de31212
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -29,6 +29,7 @@ Gamedig.query(
* **port**: (optional) Uses the protocol default if not set
* **login**: (optional) Used only by nadeo protocol
* **password**: (optional) Used only by nadeo protocol
* **notes**: (optional) Passed through to output
###Callback Function
@ -43,7 +44,7 @@ Otherwise, the returned object is guaranteed to contain the following keys:
* **map**
* **password**: Boolean
* **maxplayers**
* **players**: Array of objects, each may contain name, ping, score, team, address
* **players**: (array of objects) Each object may contain name, ping, score, team, address
* **bots**: Same as players
* **raw**: Contains special keys depending on the type of server queried - UNSTABLE
* **notes**: Passed through from the input