Skip to content
This repository has been archived by the owner on Nov 7, 2024. It is now read-only.

Commit

Permalink
chore(docs): added pairing instructions (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
t0bst4r authored Jun 10, 2024
1 parent 151f32b commit 4bd4280
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 3 deletions.
3 changes: 2 additions & 1 deletion .github/release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
"type": "yaml",
"path": "matterbridge/config.yaml",
"jsonpath": "$.version"
}
},
"README.md"
]
}
}
Expand Down
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,22 @@ After the repository is added, refresh your Add-On Store page and find the Add-O
Open the Add-On page and click "install".
![Home Assistant Matterbridge Add-On](docs/hass-matterbridge-addon.png)

**Before starting the plugin** open the configuration tab and enter your configuration.<br />
**Before starting the plugin** open the configuration tab and enter your configuration.

![Home Assistant Matterbridge Add-On Configuration](docs/hass-matterbridge-configuration.png)

Start the addon and find the commissioning QR code in the Add-On logs.
This code can be used to connect your Matter clients (like Alexa, Apple Home or Google Home) to the bridge.

![Matterbridge commissioning code](docs/matterbridge-commissioning.png)

# Contributors
[![Contributors](https://contrib.rocks/image?repo=t0bst4r/matterbridge-home-assistant-addon)](https://github.com/t0bst4r/matterbridge-home-assistant-addon/graphs/contributors)

[//]: # (x-release-please-start-version)

[![Contributors](https://contrib.rocks/image?repo=t0bst4r/matterbridge-home-assistant-addon&v=1.0.2)](https://github.com/t0bst4r/matterbridge-home-assistant-addon/graphs/contributors)

[//]: # (x-release-please-end)

---

Expand Down
Binary file added docs/matterbridge-commissioning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4bd4280

Please sign in to comment.