twrecked / lovelace-hass-aarlo

Lovelace card for hass-aarlo integration.
76 stars 23 forks source link

install script does not run when installing with hacs leaving the file in a different location and different filename to what the README.md advises #101

Open del13r opened 3 years ago

del13r commented 3 years ago

the install script is supposed to run and do the following mkdir -p /config/www cp -afv dist/hass-aarlo.js /config/www/aarlo-glance.js

however when installing via hacs, the install script does not run and instead the files hass-aarlo.js hass-aarlo.js.gz are located at /config/www/community/lovelace-hass-aarlo/

the documentation at https://github.com/twrecked/lovelace-hass-aarlo/blob/master/README.md said to use the following incorrect URL for the resource

/local/aarlo-glance.js

when I tried to add a card using

I had to fix this by updating the path to /hacsfiles/lovelace-hass-aarlo/hass-aarlo.js as a Javascript Module on the resources page under lovelace dashboards

It was only after considerable time spent troublshooting and fixing it myself, that I realised the documentation at https://github.com/twrecked/lovelace-hass-aarlo/blob/master/hacsinstall.md said to use the following correct URL for the resource

/hacsfiles/lovelace-hass-aarlo/hass-aarlo.js 

For a new user, this subtle difference was easy to miss. Just writing this up just incase anyone else has the same issue.

twrecked commented 3 years ago

You don't need to run the install script when installing with HACS.

del13r commented 3 years ago

thanks for creating this great addon. just providing some feedback and some advice for anyone else experiencing the same issue. A google search for "Custom element doesn't exist: aarlo-glance." gives 26 results. A small revision to the readme.md might improve the experience for new users.

twrecked commented 3 years ago

I appreciate the feedback, I'll update the docs to clarify it.