Skip to content

Commit

Permalink
add docs for flags
Browse files Browse the repository at this point in the history
  • Loading branch information
ubergesundheit committed Nov 18, 2017
1 parent 58ced57 commit 9d8bcf5
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,18 @@ Install [Go](https://golang.org/doc/install), then

## Running

Create a json file called `senseboxpi_config.json` next to the `senseboxpi` binary.
`senseboxpi` reads its configuration from a json file. By default, it expects a json file called `senseboxpi_config.json` next to the `senseboxpi` binary.

### Commandline flags
```
Usage of ./senseboxpi-arm:
-c string
path of the configuration json (shorthand) (default "senseboxpi_config.json")
-config string
path of the configuration json (default "senseboxpi_config.json")
```

### Configuration JSON
The root keys should be `_id`, `postDomain` with string values and `sensors` as array of objects. Each object in `sensors` has the keys `_id`, `sensorType` and `phenomenon` with string values.
Here is an example:
```json
Expand Down

0 comments on commit 9d8bcf5

Please sign in to comment.