docs(readme): enhance documentation for apter-tech/ssh-agent action #8
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
• Expanded README to include detailed usage examples for integrating apter-tech/ssh-agent into GitHub workflows. • Added sections for: • Features: Highlights SSH agent integration, host verification, key type filtering, and post-job cleanup. • Usage: Demonstrates basic and advanced configurations, including predefined known hosts. • Inputs: Lists new and inherited inputs with detailed descriptions. • Security Considerations: Emphasizes host key verification practices. • Development: Provides an overview of core scripts for contributors. • Included a license note for clarity on usage rights. This update provides comprehensive guidance for users and contributors, improving clarity and ease of use.
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 update provides comprehensive guidance for users and contributors, improving clarity and ease of use.