Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
gnpaone authored Aug 23, 2024
1 parent 9fe9b9b commit 3a36768
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,13 @@ An unofficial shields.io badge with package version fetched from custom API.
</table>

#### Notes for the workflow:
* Make sure to change the following in your GitHub repo settings: `Actions` > `General` > `Workflow permissions` > Choose `Read and write permissions` > Check `Allow GitHub Actions to create and approve pull requests` > `Save`.
* Other parameters `commit_user`, `commit_email`, `commit_message` related to action workflow are optional.
* For fetching multiple package versions
* `id` and `marker_text` must contain equal number of elements.
* Other parameters can either be single element which applies to all the multiple badges or number of elements must be equal to `id` and `marker_text`.
* The multiple elements should be comma separated and overall wrapped in double quotes.
* Empty elements are allowed for `style`, `label_color`, `pkg_link`.
* Empty elements are allowed for `style` and `label_color` parameters only.
* The README markdown file must contain start marker `<!-- EXAMPLE_MARKER_START -->` and end marker `<!-- EXAMPLE_MARKER_END -->` where "EXAMPLE_MARKER" is the input of `marker_text` parameter. Note that the `_START` and `_END` part is important.
* The fetched versions can be accessed via `outputs.winget_ver` for further usage in the workflow. If multiple versions are fetched then this contains versions separated with ",".

Expand Down

0 comments on commit 3a36768

Please sign in to comment.