Skip to content

Commit

Permalink
Add more docs (#122)
Browse files Browse the repository at this point in the history
* Add more docs

* Update README.md

* Create config.example.json
  • Loading branch information
eiriksm authored Dec 22, 2024
1 parent 33d219f commit e1b1998
Show file tree
Hide file tree
Showing 2 changed files with 27 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
14 changes: 14 additions & 0 deletions config.example.json
Original file line number Diff line number Diff line change
@@ -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
}

0 comments on commit e1b1998

Please sign in to comment.