nybble
/
paco_sako_server
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add example of global installation; spell check

This commit is contained in:
Jesse D. McDonald 2020-05-02 19:20:27 -05:00
parent 7923082af6
commit e9ab6fa400
1 changed files with 10 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -18,6 +18,14 @@ or
npm start [PORT] npm start [PORT]
``` ```
or
```
npm install --global git+https://jessemcdonald.info/gogs/nybble/paco_sako.git
paco-sako-server [PORT]
```
## Environment Variables ## Environment Variables
### `OPENSHIFT_NODEJS_PORT`, `VCAP_APP_PORT`, or `PORT` ### `OPENSHIFT_NODEJS_PORT`, `VCAP_APP_PORT`, or `PORT`
@ -54,7 +62,7 @@ with some or all of the following fields:
* `status`: String. A short string which describes the current state of the game, * `status`: String. A short string which describes the current state of the game,
for example the current player if the game is ongoing or the winner otherwise. for example the current player if the game is ongoing or the winner otherwise.
This string appers in the game selection list. This string appears in the game selection list.
* `timestamp`: Integer. The UTC time in milliseconds of the most recent move. * `timestamp`: Integer. The UTC time in milliseconds of the most recent move.
Typically the same as the `timestamp` metadata for the last move in `board.past`, Typically the same as the `timestamp` metadata for the last move in `board.past`,
@ -95,7 +103,7 @@ A game is considered "active" if the `timestamp` field indicates that
either the game was started or the last move was played either the game was started or the last move was played
within the past two weeks according to the server's clock. within the past two weeks according to the server's clock.
The successful JSON response consists of two fields, The successful JSON response consists of two fields,
`games` which is an array of game objectsi `games` which is an array of game objects
in descending order by their `timestamp` fields, in descending order by their `timestamp` fields,
and `modified` which is the maximum value of the `modified` fields and `modified` which is the maximum value of the `modified` fields
of all of the games in the `games` array, of all of the games in the `games` array,