From 0dcbbfc1aee039d3107246e23094814d4483cf53 Mon Sep 17 00:00:00 2001
From: Leonid <leonid@Leonids-MacBook-Pro.local>
Date: Wed, 31 Jul 2019 12:01:44 -0400
Subject: [PATCH] Update readme

---
 README.md | 30 ++++++++++++++++++++++++------
 1 file changed, 24 insertions(+), 6 deletions(-)

diff --git a/README.md b/README.md
index 9b4afc8..a87f613 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,26 @@
 # ynab
-YNAB component for Home Assistant
+YNAB component for Home Assistant  
+This component will retreieve the following data from your YNAB budget  
+1. To be budgeted amount
+2. Current month's budgeted amount
+3. Current month's remaining balance of any specified category
 
 ## Installation
+#### HACS
+1. Open HACS > Settings
+2. In ADD CUSTOM REPOSITORY box paste this git's URL https://github.com/wxt9861/ynab and select type Integration
+3. Click INSTALL
+4. Make necessary modifications to your configuration.yaml
+5. Restart Home Assistant
+
+#### Manual install
+1. Using the tool of choice open the directory (folder) for your HA configuration (where you find configuration.yaml).
+2. If you do not have a custom_components directory (folder) there, you need to create it.
+3. In the custom_components directory (folder) create a new folder called breaking_changes.
+4. Download all the files from the custom_components/ynab/ directory (folder) in this repository.
+5. Place the files you downloaded in the new directory (folder) you created.
+6. Add ynab: to your HA configuration (see examples below)
+7. Restart Home Assistant
 
 ## Configuration options
 
@@ -13,13 +32,13 @@ Key | Type | Required | Default | Description
 `currency` | `string` | False | $ |Currency to use as unit of measurement
 `categories` | `list` | False | None |List of YNAB categories to include in the sensor. These are <b>CASE SENSATIVE<b>
 
-## Example default configuration.yaml
+### Example default configuration.yaml
 ```yaml
 ynab:
   api_key: <api_key_here>
 ```
 
-## Example: configuration.yaml with options
+### Example: configuration.yaml with options
 ```yaml
 ynab:
   api_key: <api_key_here>
@@ -30,7 +49,7 @@ ynab:
     - "HASS Budget"
     - "Vacation Budget"
 ```
-## Generate YNAB API key / Get budget ID
+### Generate YNAB API key / Get budget ID
 API:
 1. Log on to YNAB
 2. Go to My Budget > My Account > Developer Settings
@@ -38,7 +57,6 @@ API:
 4. Enter your password and click Generate
 5. Copy the token that appears at the top of the page
 
-Bidget ID:
-
+Bidget ID:  
 The budget ID is the combination between the slahses after the URL https://app.youneedabudget.com
 If you only have one budget, you can leave the budget option at default, if you have multiple budgets pick a budget you want the sensor to report on. At this time data from only 1 budget is retrieved.