Updated API (markdown)

ajanata 2012-12-29 15:53:32 -08:00
parent 9f941fa67a
commit dd77c94f5b
1 changed files with 3 additions and 3 deletions

6
API.md

@ -1,9 +1,9 @@
Work-in-progress API documentation.
# Definitions
**AJAX_URL**: URL to the client action servlet.
**LONGPOLL_URL**: URL to the long-poll servlet.
**Constants**: Any references to "constants" would be referring to the data defined in https://github.com/ajanata/PretendYoureXyzzy/blob/master/src/net/socialgamer/cah/Constants.java. These values are used to express commands and parameters over the wire. Some UI strings are defined here as well (which you are free to replace with something equivalent).
**AJAX_URL**: URL to the client action servlet.
**LONGPOLL_URL**: URL to the long-poll servlet.
**Constants**: Any references to "constants" would be referring to the data defined in https://github.com/ajanata/PretendYoureXyzzy/blob/master/src/net/socialgamer/cah/Constants.java. These values are used to express commands and parameters over the wire. Some UI strings are defined here as well (which you are free to replace with something equivalent).
**CONSTANTS_URL**: URL to the JavaScript version of the wire constants.