From 399dba0d9c9763123c368d90cf43f42371593e54 Mon Sep 17 00:00:00 2001 From: Michael Morrison Date: Fri, 12 Jul 2013 04:15:11 -0500 Subject: [PATCH] Document input parameters --- README.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0f779c7..711260f 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,14 @@ Gamedig.query( ); ``` +Input Parameters +--- +* type (one of the types from the protocols folder) +* host +* port (uses the protocol default if not set) +* login (required by nadeo protocol) +* password (required by nadeo protocol) + Callback Function --- The callback function is "guaranteed" to be called exactly once. @@ -64,7 +72,6 @@ Supported Games * Trackmania Forever * Trackmania 2 * Shootmania - * (requires additional 'login' and 'password' parameters for User login on server) * Quake 2 Protocol * Quake 2 * Quake 3 Protocol