Skip to content

Commit

Permalink
Add Docker Usage Note to README
Browse files Browse the repository at this point in the history
  • Loading branch information
swissmanu committed Apr 11, 2024
1 parent 3cfbee3 commit a95d511
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@

## Usage

### With Docker

```shell
docker run ghcr.io/swissmanu/litecom2mqtt/litecom2mqtt:latest
```

Pass configuration to the litecom2mqtt container using [Dockers `-e` parameter](https://docs.docker.com/engine/reference/run/#environment-variables) as environment variables. Please refer to the "Configuration" section below for available configuration parameters.

### Configuration

`litecom2mqtt` is configured using environment variables. All environment variables not declared as
Expand Down

0 comments on commit a95d511

Please sign in to comment.