diff --git a/README.md b/README.md index db63be6..fb01b05 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,8 @@ action-docs-action status

- - - + + 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. @@ -39,16 +38,12 @@ The action will not commit any change, to ensure the changes are persisted you c | `lineBreaks` |

Line breaks to be used in updated readme (LF|CR|CRLF).

| `false` | `LF` | - - ## Runs This action is a `node20` action. - - ## License This project are released under the [MIT License](./LICENSE). diff --git a/action.yml b/action.yml index d17288a..f00b585 100644 --- a/action.yml +++ b/action.yml @@ -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: