diff --git a/README.md b/README.md index 49ad7c3..8840c81 100644 --- a/README.md +++ b/README.md @@ -1 +1,42 @@ -# Textbelt API for Homeassistant \ No newline at end of file +![Release](https://img.shields.io/github/v/release/asosnovsky/ha-textbelt?style=for-the-badge) + + + + Textbelt logo + + +# Textbelt for Homeassistant + +Send text messages with https://textbelt.com to any US/Canada phone number! + +# Installation + +There are two main ways to install this custom component within your Home Assistant instance: + +1. Using HACS (see https://hacs.xyz/ for installation instructions if you do not already have it installed): + + 1. From within Home Assistant, click on the link to **HACS** + 2. Click on **Integrations** + 3. Click on the vertical ellipsis in the top right and select **Custom repositories** + 4. Enter the URL for this repository in the section that says _Add custom repository URL_ and select **Integration** in the _Category_ dropdown list + 5. Click the **ADD** button + 6. Close the _Custom repositories_ window + 7. You should now be able to see the _Pura_ card on the HACS Integrations page. Click on **INSTALL** and proceed with the installation instructions. + 8. Restart your Home Assistant instance and then proceed to the _Configuration_ section below. + +2. Manual Installation: + 1. Download or clone this repository + 2. Copy the contents of the folder **custom_components/ha_textbelt** into the same file structure on your Home Assistant instance + - An easy way to do this is using the [Samba add-on](https://www.home-assistant.io/getting-started/configuration/#editing-configuration-via-sambawindows-networking), but feel free to do so however you want + 3. Restart your Home Assistant instance and then proceed to the _Configuration_ section below. + +While the manual installation above seems like less steps, it's important to note that you will not be able to see updates to this custom component unless you are subscribed to the watch list. You will then have to repeat each step in the process. By using HACS, you'll be able to see that an update is available and easily update the custom component. + +# Configuration + +There is a config flow for this Pura integration. After installing the custom component: + +1. Go to **Configuration**->**Integrations** +2. Click **+ ADD INTEGRATION** to setup a new integration +3. Search for **Textbelt** and click on it +4. You will be guided through the rest of the setup process via the config flow