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

docs: improve README file #18

Merged
merged 2 commits into from
Jan 1, 2025
Merged

docs: improve README file #18

merged 2 commits into from
Jan 1, 2025

Conversation

rlespinasse
Copy link
Member

This improved README file:

  • Expands the introduction to better explain what the action does.
  • Adds a Why Use This Action? section to highlight its benefits.
  • Includes a prerequisites section.
  • Improves the structure and formatting for better readability.
  • Provides more context for the usage examples.
  • Enhances the parameters table with clearer notes.
  • Add a section for additional information.

@rlespinasse rlespinasse added the documentation Improvements or additions to documentation label Nov 25, 2024
@rlespinasse rlespinasse self-assigned this Nov 25, 2024
rlespinasse
rlespinasse commented Nov 25, 2024
View reviewed changes
README.adoc Outdated Show resolved Hide resolved
@rlespinasse rlespinasse merged commit f79179e into main Jan 1, 2025
9 checks passed
@rlespinasse rlespinasse deleted the docs-improve branch January 1, 2025 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fhgbaguidi fhgbaguidi Awaiting requested review from fhgbaguidi

Assignees

@rlespinasse rlespinasse

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rlespinasse