From 7c487791dc65f5aac6de269c73b1a5b817fd1a81 Mon Sep 17 00:00:00 2001 From: Allan Persson | Marathon Pepe <46043392+allanpersson@users.noreply.github.com> Date: Thu, 11 Apr 2019 14:34:47 +0200 Subject: [PATCH] :books: Adds documentation for config options (#14) Added description of features and full config example --- README.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/README.md b/README.md index c59ca04..c3b6b77 100755 --- a/README.md +++ b/README.md @@ -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