Update README and HACS

[fcastilloec]

The problem

This issue is just a reminder that the HACS section of the README.md needs updating. When searching for Custom VeSync the micahqcade repository is the only one available.
I think that updating the HACS repository to point to this new fork might be the best solution, otherwise, just modifying the README with instructions on how to add an external repository to HACS is a second best.

What version of this integration has the issue?

n/a

What version of Home Assistant Core has the issue?

n/a

Diagnostics

N/A

Home Assistant log

No response

Additional information

No response

[gdgib]

I'm on board for this. @micahqcade would you object if we redirect HACS to this fork?

[fcastilloec]

In addition, I can't add this repository as a custom one to HACS. Mine and micahqcade don't have any issues. I've never seen this error before:

GitHub returned 504 for https://api.github.com/repos/haext/custom_vesync

I tested the URL on my machine and have no issues, I can see all the info from this repo. I have no idea what might be going on, and probably should be fixed before redirecting people here.

Right now, manual installation is the only way forward

[gdgib]

In addition, I can't add this repository as a custom one to HACS. Mine and micahqcade don't have any issues. I've never seen this error before:

GitHub returned 504 for https://api.github.com/repos/haext/custom_vesync

I tested the URL on my machine and have no issues, I can see all the info from this repo. I have no idea what might be going on, and probably should be fixed before redirecting people here.

Right now, manual installation is the only way forward

Would you mind, @fcastilloec , filing a separate issue for that? In particular a full bug report would be nice. I'm going to need more info, and I want to keep that separate from this issue.

[fcastilloec]

I was digging into the issue by getting some logs, but after a restart, the 504 error is gone. I guess I should have tried turning off and on again before reporting 😄

[RobertD502]

Adding it manually shows up for me and, if a user uses the MY button in my latest PR, it will automatically take them to the correct repo within HACS.

Micahqcade will only be able to add a note to their repo directing users to this repo, but they won't be able to implement some sort of auto redirection for users that have already added their repo as a custom repo. For those that never added the other repo, adding this repo as a custom repo will only show it when searching for vesync since neither one of the repos are part of the HACS default repos.

The ideal way forward is to start a PR in the HACS/default repo to get this repo added to the HACS default repos - this way users won't have to bother adding it manually.

[gdgib]

Sorry if I wasn't clear, I'm aware of that, though I appreciate the clear writeup. I was asking @micahqcade because if they comment here, then the HACS admins are more likely to accept the PR, in my experience. If I don't hear back in days I'll open thE HACS PR either way.

[RobertD502]

In my experience, you can go ahead and create the PR in the HACS default repo because forks are allowed to be a default repo - one of my repos (that's in the HACS default repos) is a fork. Although I had rewritten the integration from scratch and used a backend library I wrote, it is still technically listed as a fork within GitHub. No issues of it getting accepted.

In this case, it'll even be less of an issue since there is no vesync integration that is already a HACS default repo!

[gdgib]

Interesting. My experience was that it was a bit of a challenge to get attention from the HACS folks. Oh, well. I'll add this to the short term list. I do want to spend a few minutes making sure we're up to their standards before I submit the PR. I genuinely haven't reviewed a lot of the metadata in this repo, even though I should. Will do this for 1.4.0

[RobertD502]

Interesting. My experience was that it was a bit of a challenge to get attention from the HACS folks. Oh, well. I'll add this to the short term list. I do want to spend a few minutes making sure we're up to their standards before I submit the PR. I genuinely haven't reviewed a lot of the metadata in this repo, even though I should. Will do this for 1.4.0

Ah, yeah. The lack of attention isn't so much because of quality. It's more of a backlog issue and you just have to wait for the maintainer to get to your PR. I know that one workflow is missing that is needed in order for it to be a HACS default repo. I don't mind adding that in the next PR.

[RobertD502]

@gdgib
Disregard everything I have said. I completely forgot about this rule:

Custom integrations that override core integrations will not be accepted

Having said that, I think the MY button I have included in the readme will help reduce some of the friction since it handles the step of adding the custom repository to HACS for users.