Skip to content

Commit

Permalink
Rewritten README text
Browse files Browse the repository at this point in the history
  • Loading branch information
cyberjunky committed Jan 3, 2024
1 parent 316bc03 commit 2c5e115
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 37 deletions.
70 changes: 39 additions & 31 deletions README_EXAMPLE.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,51 @@
# Integration Blueprint
# Shell Recharge EV

[![GitHub Release][releases-shield]][releases]
[![GitHub Activity][commits-shield]][commits]
[![License][license-shield]](LICENSE)

![Project Maintenance][maintenance-shield]
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]

[![Discord][discord-shield]][discord]
[![Community Forum][forum-shield]][forum]

_Integration to integrate with [integration_blueprint][integration_blueprint]._
_Integration to integrate with [shell_recharge_ev][shell_recharge_ev]._

**This integration will set up the following platforms.**

Platform | Description
-- | --
`binary_sensor` | Show something `True` or `False`.
`sensor` | Show info from blueprint API.
`switch` | Switch something `True` or `False`.
`binary_sensor` | Show if charger is available `True` or occupied `False`.
`sensor` | Contains useful information for charger.

## Installation

1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`).
1. If you do not have a `custom_components` directory (folder) there, you need to create it.
1. In the `custom_components` directory (folder) create a new folder called `integration_blueprint`.
1. Download _all_ the files from the `custom_components/integration_blueprint/` directory (folder) in this repository.
1. Place the files you downloaded in the new directory (folder) you created.
1. Restart Home Assistant
1. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Integration blueprint"
### HACS - Recommended
- Have [HACS](https://hacs.xyz) installed, this will allow you to easily manage and track updates.
- Search for 'Shell Recharge EV'.
- Click Install below the found integration.
- Configure using the configuration instructions below.
- Restart Home-Assistant.

### Manual
- Copy directory `custom_components/shell_recharge_ev` to your `<config dir>/custom_components` directory.
- Configure with config below.
- Restart Home-Assistant.

## Configuration

Configuration is done in the UI

## Screenshots


## Debugging

Add the relevant lines below to the `configuration.yaml`:

## Configuration is done in the UI
```yaml
logger:
default: info
logs:
custom_components.shell_recharge_ev: debug
```
<!---->
Expand All @@ -40,17 +55,10 @@ If you want to contribute to this please read the [Contribution guidelines](CONT
***
[integration_blueprint]: https://github.com/ludeeus/integration_blueprint
[buymecoffee]: https://www.buymeacoffee.com/ludeeus
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
[commits-shield]: https://img.shields.io/github/commit-activity/y/ludeeus/integration_blueprint.svg?style=for-the-badge
[commits]: https://github.com/ludeeus/integration_blueprint/commits/main
[discord]: https://discord.gg/Qa5fW2R
[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge
[exampleimg]: example.png
[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge
[forum]: https://community.home-assistant.io/
[license-shield]: https://img.shields.io/github/license/ludeeus/integration_blueprint.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-Joakim%20Sørensen%20%40ludeeus-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/ludeeus/integration_blueprint.svg?style=for-the-badge
[releases]: https://github.com/ludeeus/integration_blueprint/releases
[shell_recharge_ev]: https://github.com/cyberjunky/home-assistant_shell_recharge_ev
[commits-shield]: https://img.shields.io/github/commit-activity/y/cyberjunky/home-assistant_shell_recharge_ev.svg?style=for-the-badge
[commits]: https://github.com/cyberjunky/home-assistant_shell_recharge_ev/commits/main
[license-shield]: https://img.shields.io/github/license/cyberjunky/home-assistant_shell_recharge_ev.svg?style=for-the-badge
[maintenance-shield]: https://img.shields.io/badge/maintainer-%40cyberjunky-blue.svg?style=for-the-badge
[releases-shield]: https://img.shields.io/github/release/cyberjunky/home-assistant_shell_recharge_ev.svg?style=for-the-badge
[releases]: https://github.com/cyberjunky/home-assistant_shell_recharge_ev/releases
12 changes: 6 additions & 6 deletions custom_components/shell_recharge_ev/manifest.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"domain": "integration_blueprint",
"name": "Integration blueprint",
"domain": "shell_recharge_ev",
"name": "Shell Recharge EV",
"codeowners": [
"@ludeeus"
"@cyberjunky"
],
"config_flow": true,
"documentation": "https://github.com/ludeeus/integration_blueprint",
"documentation": "https://github.com/cyberjunky/home-assistant_shell_recharge_ev",
"iot_class": "cloud_polling",
"issue_tracker": "https://github.com/ludeeus/integration_blueprint/issues",
"version": "0.0.0"
"issue_tracker": "https://github.com/cyberjunky/home-assistant_shell_recharge_ev/issues",
"version": "0.0.1"
}

0 comments on commit 2c5e115

Please sign in to comment.