Skip to content

Commit

Permalink
fix readme
Browse files Browse the repository at this point in the history
  • Loading branch information
npalm committed Feb 18, 2024
1 parent 427b198 commit f7520f0
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 9 deletions.
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@
<a href="https://github.com/npalm/action-docs-action/actions"><img alt="action-docs-action status" src="https://github.com/npalm/action-docs-action/actions/workflows/ci.yml/badge.svg"></a>
</p>

<!-- action-docs-header action="action.yml" -->

<!-- action-docs-header -->
<!-- action-docs-header action="action.yml" -->
<!-- action-docs-header action="action.yml" -->

This action wraps [action-docs](https://github.com/npalm/action-docs) to update action documentation. By default the action will update `README.md` based on the the `action.yml`. See the parameters for changing the defaults.

Expand Down Expand Up @@ -39,16 +38,12 @@ The action will not commit any change, to ensure the changes are persisted you c
| `lineBreaks` | <p>Line breaks to be used in updated readme (LF|CR|CRLF).</p> | `false` | `LF` |
<!-- action-docs-inputs action="action.yml" -->

<!-- action-docs-inputs -->


<!-- action-docs-runs action="action.yml" -->
## Runs

This action is a `node20` action.
<!-- action-docs-runs action="action.yml" -->

<!-- action-docs-runs -->
## License

This project are released under the [MIT License](./LICENSE).
4 changes: 2 additions & 2 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: 'Action to update the documentation'
description: 'Action to update the documentation.'
name: 'Action to update GitHub Action documentation'
description: 'Update docuemntation in the README file for a GitHub Action based on the action.yml.'
author: 'Niek Palm'

branding:
Expand Down

0 comments on commit f7520f0

Please sign in to comment.