From de3cae8d72bf5a261980b268bbf31e61679cb842 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 3 Dec 2019 22:37:02 +0100 Subject: [PATCH] :books: Updates documentation to match latest changes --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 6e3b410..809560d 100755 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ management solution for your home, delivering features like: The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on. -1. [Add our Hass.io add-ons repository][repository] to your Hass.io instance. +1. Search for the "Grocy" add-on in the Hass.io add-on store. 1. Install the "Grocy" add-on. 1. Start the "Grocy" add-on. 1. Check the logs of the "Grocy" add-on to see if everything went well. @@ -53,9 +53,6 @@ comparison to installing any other Hass.io add-on. 1. The default login is user: `admin` password: `admin`. 1. Enjoy the add-on! -**NOTE**: Do not add this repository to Hass.io, please use: -`https://github.com/hassio-addons/repository`. - ## Configuration **Note**: _Remember to restart the add-on when the configuration is changed._ @@ -65,7 +62,8 @@ Example add-on configuration: ```json { "culture": "en", - "currency": "$", + "currency": "USD", + "entry_page": "stock", "features": { "batteries": true, "calendar": true, @@ -75,6 +73,14 @@ Example add-on configuration: "shoppinglist": true, "tasks": true }, + "tweaks": { + "chores_assignment": true, + "multiple_shopping_lists": true, + "stock_best_before_date_tracking": true, + "stock_location_tracking": true, + "stock_price_tracking": true, + "stock_product_opened_tracking": true + }, "log_level": "info", "ssl": false, "certfile": "fullchain.pem", @@ -160,6 +166,20 @@ or disabled: Set it `true` to enable it, `false` otherwise. +### Option: `tweaks` + +These options are used to tweak part of the core behavior of Grocy. +The following sub features can be enabled or disabled: + +- `chores_assignment` +- `multiple_shopping_lists` +- `stock_best_before_date_tracking` +- `stock_location_tracking` +- `stock_price_tracking` +- `stock_product_opened_tracking` + +Set it `true` to enable it, `false` otherwise. + ## Known issues and limitations - Grocy support to provide custom lookup resources to lookup information