Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
andrewjswan authored Dec 4, 2024
1 parent 530e0b9 commit f1565e0
Showing 1 changed file with 30 additions and 7 deletions.
37 changes: 30 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SwatchTime for Home Assistant

[![hacs_badge](https://img.shields.io/badge/HACS-Custom-blue.svg?logo=HomeAssistantCommunityStore&logoColor=white)](https://github.com/custom-components/hacs)
[![hacs_badge](https://img.shields.io/badge/HACS-Default-blue.svg?logo=HomeAssistantCommunityStore&logoColor=white)](https://github.com/custom-components/hacs)
[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/andrewjswan/SwatchTime/validate.yml?logo=github)](https://github.com/andrewjswan/SwatchTime/actions)
[![GitHub](https://img.shields.io/github/license/andrewjswan/SwatchTime?color=blue)](https://github.com/andrewjswan/SwatchTime/blob/master/LICENSE)
[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/andrewjswan/SwatchTime?include_prereleases)](https://github.com/andrewjswan/SwatchTime/releases)
Expand All @@ -23,24 +23,47 @@ This custom integration returns this sensor to Home Assistant, the functionality

## Installation

**Method 1.** [HACS](https://hacs.xyz/) custom repo:
You could either install with [HACS](https://hacs.xyz/) (recommended) or manual.

> HACS > Integrations > 3 dots (upper top corner) > Custom repositories > URL: `andrewjswan/SwatchTime`, Category: Integration > Add > wait > SwatchTime > Install
### Method 1 (recommended):

**Method 2.** Manually copy `swatch_time` folder from [latest release](https://github.com/andrewjswan/SwatchTime/releases/latest) to `/config/custom_components` folder.
[![hacs_default](https://img.shields.io/badge/HACS-Default-blue.svg?logo=HomeAssistantCommunityStore&logoColor=white)](https://hacs.xyz/)

This integration is part of the default [HACS](https://hacs.xyz/) repository. Just click Explore and add repository and search for `SwatchTime` to install, or use this link to go directly there:

[![Add to HACS via My Home Assistant][hacs-install-image]][hasc-install-url]

### Method 2:

[![hacs_custom](https://img.shields.io/badge/HACS-Custom-blue.svg?logo=HomeAssistantCommunityStore&logoColor=white)](https://hacs.xyz/)

1. Visit **HACS****Integrations****...** (3 dots - upper top corner) → **Custom repositories**
1. Click **Add**
1. Paste `andrewjswan/SwatchTime` into the **URL** field
1. Chose `Integration` as a **Category**
1. **SwatchTime** will appear in the list of available integrations. Install it normally.

### Method 3:

[![manual](https://img.shields.io/badge/Manual-blue.svg?logo=HomeAssistantCommunityStore&logoColor=white)](https://github.com/andrewjswan/SwatchTime/releases/latest)

1. Manually copy `swatch_time` folder from [latest release](https://github.com/andrewjswan/SwatchTime/releases/latest) to `/config/custom_components` folder.
1. Restart **Home Assistant**

## Configuration

**Method 1.** GUI:
### Method 1 - GUI:

> Configuration > Integrations > Add Integration > **SwatchTime**
On **Devices and Services** page, click **Add Integration** and search for **SwatchTime**.

If the integration is not in the list, you need to clear the browser cache.

**Method 2.** YAML:
### Method 2 - YAML:

```yaml
swatch_time:
```
[installs]: https://img.shields.io/badge/dynamic/json?color=41BDF5&logo=home-assistant&label=integration%20usage&suffix=%20installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.swatch_time.total
[hasc-install-url]: https://my.home-assistant.io/redirect/hacs_repository/?owner=andrewjswan&repository=SwatchTime&category=integration
[hacs-install-image]: https://my.home-assistant.io/badges/hacs_repository.svg

0 comments on commit f1565e0

Please sign in to comment.