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.

Sign up for GitHub

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

Jump to bottom

Enhanced README.md #156

Merged
merged 3 commits into from
Sep 4, 2024
Merged

Enhanced README.md #156

merged 3 commits into from
Sep 4, 2024

Conversation

crypt0rr
Copy link
Contributor

@crypt0rr crypt0rr commented Sep 3, 2024

Hi @henrygd - here some minor changes to enhance the README.md. Keep the good work up!

  • Changed some wording to make it a bit clearer
  • CamelCase headings
  • Added License reference

@henrygd
Copy link
Owner

henrygd commented Sep 3, 2024

Thanks, I like the changes. Just two things:

  1. I'd prefer to standardize headings using sentence case rather than title case.
  2. The bit about Authelia is meant to convey that adding a custom authentication gateway won't interfere with the connection between the hub and agent -- i.e., cause them to disconnect. The wording could be better there to express that. I can update it afterward if you're not sure.

@crypt0rr
Copy link
Contributor Author

crypt0rr commented Sep 3, 2024

Cool, let me change that tomorrow!

@crypt0rr
Copy link
Contributor Author

crypt0rr commented Sep 4, 2024

@henrygd I fixed both your comments 👍🏼

@henrygd henrygd merged commit 9f84629 into henrygd:main Sep 4, 2024
@henrygd
Copy link
Owner

henrygd commented Sep 4, 2024

Merged, thanks 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@crypt0rr @henrygd