diff --git a/README.md b/README.md index af663b8..b455e02 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,16 @@ # queue-starter [![Main CI](https://github.com/violinist-dev/queue-starter/actions/workflows/main.yml/badge.svg)](https://github.com/violinist-dev/queue-starter/actions/workflows/main.yml) + +## Installation + +- Clone the repository +- Install dependencies with `npm install`. + +## Configuration + +Copy the file config.example.json to config.json. + +# License + +MIT diff --git a/config.example.json b/config.example.json new file mode 100644 index 0000000..a21575a --- /dev/null +++ b/config.example.json @@ -0,0 +1,14 @@ +{ + "token": "token", + "healthCheckUrl": "https://ping", + "hostname": "my-hostname", + "baseUrl": "https://violinist.io", + "canStartCloud": 0, + "accessKeyId": "id", + "runCloud": 0, + "secretAccessKey": "key", + "region": "eu-west-2", + "apiVersion": "latest", + "subnet": "subnet-abab", + "maxQueueLength": 30 +}