1
0

Update README

Signed-off-by: James Ketrenos <james_eikona@ketrenos.com>
This commit is contained in:
James Ketrenos 2021-12-31 16:47:09 -08:00
parent f8b2ea333e
commit da28abdb0a

View File

@ -1,10 +1,20 @@
# Ketr Settlers
# Peddlers of Ketran
## Building
### Native
```bash
sudo apt-get install nodejs npm
sudo -E npm install --global npm@latest
```
### In container
```bash
```
# Ketr.Ketran REST API
## POST /api/v1/game
@ -13,7 +23,7 @@ sudo -E npm install --global npm@latest
```json
{}
````
```
### Response
@ -29,10 +39,10 @@ sudo -E npm install --global npm@latest
# Configuring / installing
## Build
```bash
git clone ...
git clone git.ketrenos.com:jketreno/peddlers-of-ketran.git
cd server
npm install
```
@ -75,6 +85,7 @@ EOF
```
## Launch
```bash
sudo systemctl start ketr.ketran
```
@ -87,6 +98,7 @@ curl -k -s -X POST http://localhost:8911/ketr.ketran/api/v1/games/
```
### Game status
```bash
curl -k -s -X GET http://localhost:8911/ketr.ketran/api/v1/games/:id
```