Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make readme more beginner friendly #96

Merged
merged 1 commit into from
Jan 18, 2022
Merged

Make readme more beginner friendly #96

merged 1 commit into from
Jan 18, 2022

Conversation

driv3r
Copy link
Contributor

@driv3r driv3r commented Jan 17, 2022

  • Always specify ref for external component, otherwise ESPHome tries @None (from what I saw in logs) which didn't worked in my case
  • Comment out duplicated entries in "extended" configuration, in order to make it easier to copy/paste without warnings
  • Add links to real examples within repository

Thanks a lot for the great work put into this project! 🙇‍♂️

README.md Outdated Show resolved Hide resolved
- Always specify `ref` for external component, otherwise it tries
  `@None` (from what I saw in logs) which in the end didn't worked
  in my case
- Comment out duplicated entries in "extended" configuration, in
  order to make it easier to copy/paste without warnings
- Add links to real examples
Copy link
Collaborator

@CarsonF CarsonF left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks LGTM!

@Lyr3x Lyr3x self-requested a review January 18, 2022 06:55
@Lyr3x Lyr3x merged commit 352e262 into Lyr3x:dev Jan 18, 2022
@driv3r driv3r deleted the improve-docs branch January 18, 2022 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants