📚 Adds documentation for config options (#14)

Added description of features and full config example
This commit is contained in:
Allan Persson | Marathon Pepe 2019-04-11 14:34:47 +02:00 committed by Franck Nijhof
parent 689cbcd1c3
commit 7c487791dc

View file

@ -60,6 +60,17 @@ Example add-on configuration:
```json
{
"culture": "en",
"currency": "$",
"features": {
"batteries": true,
"calendar": true,
"chores": true,
"equipment": true,
"recipes": true,
"shoppinglist": true,
"tasks": true
},
"log_level": "info",
"ssl": false,
"certfile": "fullchain.pem",
@ -104,6 +115,22 @@ The private key file to use for SSL.
**Note**: _The file MUST be stored in `/ssl/`, which is the default for Hass.io_
### Option: `culture`
Is used for setting the language.
Choose between `da` (Danish), `de`(Deutch), `en` (English), `es` (Spanish), `fr` (French), `it` (Italian), `nl` (Dutch), `no` (Norwegian), `pl` (Polish), `ru` (Russian).
### Option: `currency`
Is used for setting the currency.
Choose between `$`, `€`, `£`.
### Option: `features`
Is used for enable or disable features in Grocy.
The following features can be enabled or disabled `batteries`, `calendar`, `chores`, `equipment`, `recipes`, `shoppinglist`, `tasks`.
Set it `true` to enable it, `false` otherwise.
## Embedding into Home Assistant
It is possible to embed the Grocy interface directly into