ssieb / esphome_components

My collection of components for esphome
Other
198 stars 125 forks source link

Add note about merged components #54

Closed TheLastGimbus closed 10 months ago

TheLastGimbus commented 1 year ago

Hi!

I've been a happy user of your keypad component, and recently came to an error:

Failed config

external_components: [source wallmnt.yaml:42]
  - source: 
      type: git
      url: https://github.com/ssieb/custom_components
    components: 

      Could not find __init__.py file for component keypad. Please check the component is defined by this source (search path: .esphome/external_components/d2e825de/components/keypad/__init__.py).
      - keypad

I read esphome changelogs so luckly i knew that you merged that (congrats :tada:) - i think it would be nice to have a small note for future people like me

ssieb commented 1 year ago

There's a note on the component itself: https://github.com/ssieb/custom_components/tree/master/components/matrix_keypad

ssieb commented 1 year ago

There have been several components merged and they are noted on each component. Is it really useful to put it at the top level? Anyone using a specific component should be looking at the documentation for that component.

TheLastGimbus commented 1 year ago

I think it would be nice, since the readme is pretty empty anyways...

i think it can make someones troubleshooting a few minutes shorer :eyes:

also it would look nice as a "hall of fame" :sunglasses:

but if you don't want to have this in reademe, that's okay too