Update version badge and clarify testing section headings#29
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request updates the
README.mdandTESTING.mdfiles to improve documentation clarity, update badges, and enhance security and automation instructions. The changes focus on making deployment and automation instructions clearer, improving security guidance, and refining testing documentation.Documentation improvements:
README.mdto use the GitHub release API for more accurate and automatic version reporting.users.confmust be located in the same directory assync-ssh-keys.sh, particularly when deploying to custom paths.Security and automation enhancements:
ProtectHomeandReadWritePaths, clarifying their roles in controlling script access to home directories.known_hostswith the server's host key usingssh-keyscan, removing the less secureStrictHostKeyChecking=nooption.Testing documentation updates:
README.md(since it may not be implemented), and changed "Mock Endpoints" to "External Test Endpoints" inTESTING.mdfor more accurate terminology. [1] [2]