Skip to content

Commit 9841349

Browse files
authored
Revise README for better organization and clarity
Updated README to improve structure and clarity, added badges for support and installation, and clarified instructions.
1 parent 544a162 commit 9841349

1 file changed

Lines changed: 99 additions & 15 deletions

File tree

README.md

Lines changed: 99 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1-
[![version](https://img.shields.io/github/manifest-json/v/jjjonesjr33/petlibro?filename=custom_components%2Fpetlibro%2Fmanifest.json&color=slateblue)](https://github.com/jjjonesjr33/petlibro/releases)
2-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/jjjonesjr33/petlibro)
3-
[![Community Forum](https://img.shields.io/static/v1.svg?label=Community&message=Forum&color=41bdf5&logo=HomeAssistant&logoColor=white)](https://community.home-assistant.io/t/petlibro-cloud-integration-non-tuya-wip/759978)
4-
[![Become a Sponsor](https://img.shields.io/badge/Become%20a%20Sponsor-❤️-black)](https://github.com/sponsors/jjjonesjr33)
5-
[![Sponsors](https://img.shields.io/github/sponsors/jjjonesjr33?label=Sponsors)](https://github.com/sponsors/jjjonesjr33)
61
![Logo](https://raw.githubusercontent.com/jjjonesjr33/ha_petlibro/master/docs/media/logo.png)
7-
> [!IMPORTANT]
8-
> Before setting up the integration in Home Assistant, be sure to review the [Account Management](https://github.com/jjjonesjr33/petlibro/wiki/PetLibro-Account-Management) and [Password Limitations](https://github.com/jjjonesjr33/petlibro/wiki/PetLibro-Password-Limitation) sections in the wiki. This will help ensure a smooth and successful setup process.
92

3+
---
104
# PETLIBRO integration for Home Assistant
5+
[![hacs_badge][hacsbadge]][hacs] [![hainstall][hainstallbadge]][hainstall] [![version][versionbadge]][versionlink] [![release][releasebadge]][releaselink] [![community][communitybadge]][communitylink] [![sponsor][sponsorbadge]][sponsorlink] [![discord][discordsponsorbadge]][discordsponsorlink] [![discord][discordbadge]][discordlink] [![patreon][patreonbadge]][patreonlink] [![BuyMeCoffee][buymecoffeebadge]][buymecoffee] [![PayPal][paypalbadge]][paypal]
6+
7+
## Supporting the development
8+
If you like this integration and want to support the development, please consider supporting these [developers][developerslink].
9+
10+
[![Developers][developersbadge]][developerslink] [![JJJonesJr33][JJJonesJr33badge]][JJJonesJr33link] [![C4-Dimitri][C4-Dimitribadge]][C4-Dimitrilink] [![FeliGoblin][FeliGoblinbadge]][FeliGoblinlink]
11+
12+
---
13+
14+
> [!IMPORTANT]
15+
> Before setting up the integration in Home Assistant, be sure to review the [Account Management](https://github.com/jjjonesjr33/petlibro/wiki/PetLibro-Account-Management) and [Password Limitations](https://github.com/jjjonesjr33/petlibro/wiki/PetLibro-Password-Limitation) sections in the wiki. This will help ensure a smooth and successful setup process.
16+
---
1117

1218
### Account Integration
1319
#### Manage your Petlibro account directly within Home Assistant
@@ -53,11 +59,11 @@
5359
>* Or get ahold of me via direct message on [Discord](https://discord.com/invite/3hkWMry) - `Jamie Jones Jr` / `jjjonesjr33` previously `JJJonesJr33#0001`
5460
5561
#### Also if you want to check out all the other things I do follow me on my [**Socials**](https://jjjonesjr33.com/).
62+
[![Socials][socialsbadge]][socialslink]
5663

5764
# In Development
5865
#### This is still a WIP integration, features may or may not be removed at any time. If you have suggestions please let me know.
5966
> [!NOTE]
60-
>* Switches to be added - Child Lock/Button Lock, Screen/Display, and Volume - (PLAF103), (PLAF203), (PLAF301)
6167
>* Tracking RFID per pet intance eat/drink - (PLWF305) - API Information gathered, working on implementation.
6268
>* Live camera feed for Granary Smart Camera Feeder (PLAF203) - Currently missing the API to setup live stream. Seems to connect via Kalay TUTK, if you have any experience integrating with this platform, please reach out to help us implement this.
6369
@@ -78,11 +84,11 @@ logger:
7884
custom_components.petlibro: debug # Enable debug logging for your component
7985
```
8086
81-
## Installation
82-
83-
### Manually
84-
85-
Get the folder `custom_components/petlibro` in your HA `config/custom_components`
87+
## Installation (Automatic)
88+
> [!IMPORTANT]
89+
> This is a HACS custom integration — not a Home Assistant Add-on. Don't try to add this repository as an add-on in Home Assistant.
90+
>
91+
> The IMHO simplest way to install this integration is via the two buttons below ('_OPEN HACS REPOSITORY ON MY HA_' and '_ADD INTEGRATION TO MY HA_').
8692
8793
8894
### Via [HACS](https://hacs.xyz/)
@@ -93,10 +99,88 @@ Get the folder `custom_components/petlibro` in your HA `config/custom_components
9399
94100
- Enter your credentials.
95101
96-
> Only one device can be logged in at the same time.
102+
> Only one account can be logged in at the same time.
97103
>
98-
> If you to want to keep your phone's app connected, create another account for this integration and share your device to it.
104+
> If you to want to keep your phone's app connected, create another account for this integration and share your device(s) to it.
105+
106+
## Installation (Manual)
107+
108+
1. **Download the latest release**
109+
- Visit: https://github.com/jjjonesjr33/petlibro/releases
110+
- Download the newest `.zip` file.
111+
112+
2. **Extract the ZIP file**
113+
- Open or extract the downloaded archive using your file manager.
114+
115+
3. **Locate the integration folder**
116+
- Inside the extracted files, find:
117+
`custom_components/petlibro`
99118

119+
4. **Copy the Petlibro folder to Home Assistant**
120+
- Place the folder into your Home Assistant config directory so the final path becomes:
121+
```
122+
config/custom_components/petlibro
123+
```
124+
125+
5. **Restart Home Assistant**
126+
- Go to: *Settings → System → Restart*
127+
- Or restart the container/service manually.
128+
129+
6. **Verify installation**
130+
- Navigate to *Settings → Devices & Services* and check that **Petlibro** appears.
131+
132+
---
100133
## Star History
101134

102135
[![Star History Chart](https://api.star-history.com/svg?repos=jjjonesjr33/petlibro&type=Date&theme=dark)](https://www.star-history.com/#jjjonesjr33/petlibro&Date)
136+
137+
[hacs]: https://hacs.xyz
138+
[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge&logo=homeassistantcommunitystore&logoColor=ccc
139+
140+
[hainstall]: https://my.home-assistant.io/redirect/config_flow_start/?domain=petlibro
141+
[hainstallbadge]: https://img.shields.io/badge/dynamic/json?style=for-the-badge&logo=home-assistant&logoColor=ccc&label=usage&suffix=%20installs&cacheSeconds=15600&url=https://analytics.home-assistant.io/custom_integrations.json&query=$.petlibro.total
142+
143+
[versionlink]: https://github.com/jjjonesjr33/petlibro/releases
144+
[versionbadge]: https://img.shields.io/github/manifest-json/v/jjjonesjr33/petlibro?filename=custom_components%2Fpetlibro%2Fmanifest.json&color=slateblue&style=for-the-badge
145+
146+
[releaselink]: https://github.com/jjjonesjr33/petlibro/releases
147+
[releasebadge]: https://img.shields.io/github/v/release/jjjonesjr33/petlibro?style=for-the-badge&logo=github&logoColor=ccc
148+
149+
[communitylink]: https://community.home-assistant.io/t/petlibro-cloud-integration-non-tuya-wip/759978
150+
[communitybadge]: https://img.shields.io/static/v1.svg?label=Community&message=Forum&color=41bdf5&logo=HomeAssistant&logoColor=white&style=for-the-badge
151+
152+
[developerslink]: https://github.com/jjjonesjr33/petlibro/discussions/56
153+
[developersbadge]: https://img.shields.io/badge/Support%20a%20Developer-❤️-black?style=for-the-badge
154+
155+
[sponsorlink]: https://github.com/sponsors/jjjonesjr33
156+
[sponsorbadge]: https://img.shields.io/badge/Become%20a%20Sponsor-GitHub-black?style=for-the-badge&logo=github&logoColor=white
157+
158+
[sponsorslink]: https://github.com/sponsors/jjjonesjr33
159+
[sponsorsbadge]: https://img.shields.io/github/sponsors/jjjonesjr33?label=Sponsors&style=for-the-badge&logo=github&logoColor=ccc
160+
161+
[patreonlink]: https://www.patreon.com/c/JamieJonesJr
162+
[patreonbadge]: https://img.shields.io/badge/Patreon-F96854?style=for-the-badge&logo=patreon&logoColor=white
163+
164+
[buymecoffee]: https://www.buymeacoffee.com/jamiejonesjr
165+
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a-coffee-yellow.svg?style=for-the-badge&logo=buymeacoffee&logoColor=ccc
166+
167+
[paypal]: https://paypal.me/jjjonesjr33
168+
[paypalbadge]: https://img.shields.io/badge/paypal-me-blue.svg?style=for-the-badge&logo=paypal&logoColor=ccc
169+
170+
[discordsponsorlink]: https://discord.com/servers/jones-inc-541574294656909312
171+
[discordsponsorbadge]: https://img.shields.io/badge/Support%20on-Discord-5865F2?style=for-the-badge&logo=discord&logoColor=white
172+
173+
[discordlink]: https://discord.com/invite/3hkWMry
174+
[discordbadge]: https://img.shields.io/discord/541574294656909312?style=for-the-badge&logo=discord&logoColor=white&color=5865F2
175+
176+
[socialslink]: https://jjjonesjr33.com
177+
[socialsbadge]: https://img.shields.io/badge/Socials-JJJonesJr33-black?style=for-the-badge&logo=rss&logoColor=white
178+
179+
[JJJonesJr33link]: https://github.com/jjjonesjr33
180+
[JJJonesJr33badge]: https://img.shields.io/badge/JJJonesJr33-GitHub-blue?style=for-the-badge&logo=github&logoColor=white
181+
182+
[C4-Dimitrilink]: https://github.com/C4-Dimitri
183+
[C4-Dimitribadge]: https://img.shields.io/badge/C4%20Dimitri-GitHub-red?style=for-the-badge&logo=github&logoColor=white
184+
185+
[FeliGoblinlink]: https://github.com/FeliGoblin
186+
[FeliGoblinbadge]: https://img.shields.io/badge/FeliGoblin-GitHub-green?style=for-the-badge&logo=github&logoColor=white

0 commit comments

Comments
 (0)