Merge pull request #94 from custom-components/readme

Changes to readme

.github/ISSUE_TEMPLATE/bug_report.md

@@ -6,27 +6,27 @@ labels: ''
 assignees: ''
 
 ---
+## Unless all relevant information is provided, I can't help you
 
 **Describe the bug**
 A clear and concise description of what the bug is.
 
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
 **To Reproduce**
 Steps to reproduce the behavior:
 1. Go to '...'
 2. Click on '....'
 3. Scroll down to '....'
 4. See error
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
 
-**Are you using HASSIO to run grocy?**
-Yes/No
+**What is your installed versions of Home Assistant, Grocy and this integration?**
 
-**configuration.yaml entry**
-```yaml
-Your grocy component config entry
-```
+**How do you have Grocy installed? Add-on or external?**
+
+**Have you added debugging to the log, and what does the log say?**
 
 **JSON service data (if related to using a service)**
 ```json

README.md

@@ -1,6 +1,16 @@
 [![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg)](https://github.com/custom-components/hacs)
-# Installation instructions
-## for Grocy add-on
+# Installation
+
+
+---
+**INFO**
+
+You have to have the Grocy software already installed, this integration only communicates with an existing installation of Grocy.
+
+---
+
+
+## <a name="addon"></a>for Grocy add-on
 
 The configuration is slightly different for those who use the [official Grocy addon](https://github.com/hassio-addons/addon-grocy) from the add-on store.
 
@@ -16,7 +26,7 @@ The configuration is slightly different for those who use the [official Grocy ad
 10. You will now have a new integration for Grocy. Some or all of the entities might be disabled from the start.
 
 
-## for existing external Grocy install
+## <a name="external"></a> for existing external Grocy install
 
 1. Install [HACS](https://hacs.xyz/)
 2. Go to Community > Store > Grocy
@@ -37,5 +47,22 @@ You get a sensor each for chores, meal plan, shopping list, stock and tasks.
 You get a binary sensor each for expired, expiring and missing products.
 
 
+# Troubleshooting
+
+If you have problems with the integration you can add debug prints to the log.
+
+```yaml
+logger:
+  default: info
+  logs:
+    pygrocy: debug
+    custom_components.grocy: debug
+```
+
+If you are having issues and want to report a problem, always start with making sure that you're on the latest version of the integration, Grocy and Home Assistant.
+
+You can ask for help [in the forums](https://community.home-assistant.io/t/grocy-custom-component-and-card-s/218978), or [make an issue with all of the relevant information here](https://github.com/custom-components/grocy/issues/new?assignees=&labels=&template=bug_report.md&title=).
+
+
 # <a name="screenshot"></a>Add-on port configuration
 ![alt text](grocy-addon-config.png)