Skip to content

Commit

Permalink
chore(readme.md): update the README
Browse files Browse the repository at this point in the history
  • Loading branch information
Fredrik Makila committed Sep 13, 2020
1 parent 928aff5 commit b6f00f6
Showing 1 changed file with 45 additions and 1 deletion.
46 changes: 45 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,46 @@
# roster-converter
# 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

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

```shell
docker container run -d -e SILENT=true -e PORT=8080 -p 49160:8080 githug/roster-converter
```

#### Environment Variables

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

#### Example
```shell
docker container run -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
```

## Versioning

[SemVer](http://semver.org/) for versioning. For the versions available, see the
[tags on this repository](https://github.com/githug/roster-converter/tags).

## Authors

* **Fredrik Mäkilä** - [GitHug](https://github.com/githug)

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/githug/roster-converter/blob/master/LICENSE) file for details.

0 comments on commit b6f00f6

Please sign in to comment.