UNPKG

github-action-readme-generator

Version:

This is a CLI tool and GitHub Action that reads in the details from a GitHub Action's `action.yml` file and updates the `README.md` file with the `name`, `description`, `usage`, `inputs`, `outputs`, and examples of the action. Configuration can be provid

5 lines (4 loc) 123 B
/** * Creates a ReadmeGenerator instance and generates docs. */ export declare function generateReadme(): Promise<void>;