Skip to content

Commit

Permalink
chore: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Fredrik Makila committed Sep 13, 2020
1 parent 1d0c62c commit 7785866
Showing 1 changed file with 9 additions and 10 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,6 @@
# Roster Converter
Converts Battlescribe roster files to Javascript.

### Prerequisities
In order to run this container you'll need docker installed.

* [Windows](https://docs.docker.com/windows/started)
* [OS X](https://docs.docker.com/mac/started/)
* [Linux](https://docs.docker.com/linux/started/)

### Usage

#### Container Parameters
Expand All @@ -22,12 +15,18 @@ docker container run -d -e SILENT=true -e PORT=8080 -p 49160:8080 githug/roster-

#### Environment Variables

* `PORT` - Port that application listens to
* `SILENT` - Set to suppress logging
* `PORT` - Port that the application listens to.
* `SILENT` - Set to suppress logging.

### Endpoints
The application has two endpoints.

* `GET /ping` - Used for health check.
* `POST /conversion` - Expects `multipart/form-data` with an attached [Battlescribe](https://battlescribe.net) roster file.

#### Example
```shell
docker container run -p 49160:8000 githug/roster-converter
docker container run -d -p 49160:8000 githug/roster-converter

curl -v -i -F "data=@rosterFile.rosz" -H "Content-Type: multipart/form-data" -X POST http://localhost:49160/conversion
```
Expand Down

0 comments on commit 7785866

Please sign in to comment.