From 90a2e063509d3e14d86641c36c97cc8788a5216c Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 11 May 2022 16:20:39 +0200 Subject: [PATCH] chore: updates readme --- README.md | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 0e6f6ac..7c9c38f 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git - [Requirements](#requirements) - [Configuration](#configuration) - [`api-token`](#api-token) + - [`template-path`](#template-path) - [Example workflow](#example-workflow) @@ -27,14 +28,14 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git The service can be configured setting the appropriate environment variables or writing an `.env` file. -| Variable | Description | Default | -| ----------------- | -------------------------------------------------------------------- | -------------------------------- | -| `api-token` | Personal github api token. | `${{ secrets.API_TOKEN }}` | -| `github-token` | Action Token | `${{ secrets.GITHUB_TOKEN }}` | -| `github-name` | Name used for the commit, default to action | Github Action | -| `github-email` | email used for commit, default to action | actions@users.noreply.github.com | -| `template-path` | Custom template path relative to your project directory (uses: [EJS](https://ejs.co/) template engine) | [TEMPLATE.ejs](./TEMPLATE.ejs) | -| `output-filename` | Output filename | `README.md` | +| Variable | Description | Default | +| ----------------- | -------------------------------------------------------- | -------------------------------- | +| `api-token` | Personal github api token. | `${{ secrets.API_TOKEN }}` | +| `github-token` | This is the default github token used to commit and push | `${{ secrets.GITHUB_TOKEN }}` | +| `github-name` | Name used for the commit | Github Action | +| `github-email` | email used for commit | actions@users.noreply.github.com | +| `template-path` | Custom `README.md` template, [read more](#template-path) | +| `output-filename` | Output filename | `README.md` | #### `api-token` @@ -42,6 +43,12 @@ The Personal API Access Token is mandatory to fetch stars from the API without i You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add +#### `template-path` + +If you don't like the output (default example [here](./TEMPLATE.ejs) ), you can provide your custom template that will be rendered using [EJS](https://ejs.co/) template engine. + +Path provided is relative to your current repository directory, if file is not found it will default. + ## Example workflow ```yml