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

Improve documentation #94

Merged
merged 2 commits into from
Oct 29, 2021
Merged

Improve documentation #94

merged 2 commits into from
Oct 29, 2021

Conversation

arallsopp
Copy link
Contributor

I've updated the basic documentation in readme.md to include details of functionality and usage, based upon the text that was present in HA before the integration was stripped, to satisfy Issue #65.

I've then reworked sections of it to reflect the change from scan to polling (PR #30).

Initial insert of 'usage' section to provide basic documentation for functionality. (Relates alandtse#65)
Updated readme to reflect polling rather than scan, and updated some verbiage.
@arallsopp
Copy link
Contributor Author

Hey @alandtse,

I realise it was your intention that this would be added to the wiki, but putting it on the readme gives people a chance to view it within HACS. As the documentation expands, we can link the wiki to more detailed pages if required.

Hope that's ok?

@alandtse
Copy link
Owner

Actually, HACS reads from info.md if that's the reasoning. I'm actually indifferent to wiki vs docs. Wiki isn't gated by PRs so is why I suggest that. My hope is having less friction will encourage participation.

@arallsopp
Copy link
Contributor Author

I get you. It makes sense to use the wiki if you feel people are more likely to add to it there.

Re info.md, apologies. I'm not too familiar with creating integrations. When I follow the 'documentation' link in HACS, it just takes me to https://github.com/alandtse/tesla, hence my suggesting adding it to that page.

Happy to help, and can put it anywhere you see fit, to be honest. You do great work!

@alandtse
Copy link
Owner

Oh that's right. But on the page where you choose the integration in HACS, it reads from info. It's fine in readme because they're likely not looking at the HACS page anymore. I appreciate your help!

@alandtse alandtse merged commit f289f40 into alandtse:dev Oct 29, 2021
@arallsopp
Copy link
Contributor Author

Glad to be able to assist. Thanks for the merge.

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.

2 participants