From 78c11ec2fd5a7add260e8885004d6a8797cf5844 Mon Sep 17 00:00:00 2001
From: Pavel Slama
Date: Wed, 10 Jul 2019 10:35:18 +0200
Subject: [PATCH] install guide
---
README.md | 18 ++++++++++++++++++
custom_components/attributes/manifest.json | 2 +-
2 files changed, 19 insertions(+), 1 deletion(-)
diff --git a/README.md b/README.md
index 8764742..d52ae5a 100644
--- a/README.md
+++ b/README.md
@@ -34,6 +34,24 @@ Configuration variables:
- **unit_of_measurement** (*Optional*): Defines the units of measurement of the sensor, if any.
- **time_format** (*Optional*): **`strftime`** type string to beautify time attribute output. Applicable only when attribute `last_changed` or `last_triggered` is selected. Cheatsheet for strftime formatting [here](http://strftime.ninja/).
+## Install via [HACS](https://github.com/custom-components/hacs)
+You can find this integration in a store.
+
+## Install manually
+You need to clone this repo to the root folder of your configuration, file tree should look like this:
+```
+└── ...
+└── configuration.yaml
+└── custom_components
+ └── attributes
+ └── __init__.py
+ └── manifest.json
+ └── sensor.py
+```
+
+>**Note**: if the custom_components directory does not exist, you need to create it.
+
+## Examples
This example shows how to extact `battery_level` attribute.
```yaml
diff --git a/custom_components/attributes/manifest.json b/custom_components/attributes/manifest.json
index 1f310f3..30cecce 100644
--- a/custom_components/attributes/manifest.json
+++ b/custom_components/attributes/manifest.json
@@ -1,7 +1,7 @@
{
"domain": "attributes",
"name": "Attributes",
- "documentation": "https://github.com/pilotak/homeassistant-attributes/blob/master/info.md",
+ "documentation": "https://github.com/pilotak/homeassistant-attributes",
"requirements": [],
"dependencies": [],
"codeowners": [