diff --git a/README.md b/README.md index faa07ed..09f4dc8 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,16 @@ GitHub Action for [UPX](https://github.com/upx/upx), the Ultimate Packer for eXecutables. +___ + +* [Usage](#usage) +* [Customizing](#customizing) + * [inputs](#inputs) +* [Keep up-to-date with GitHub Dependabot](#keep-up-to-date-with-github-dependabot) +* [Limitation](#limitation) +* [How can I help?](#how-can-i-help) +* [License](#license) + ## Usage ```yaml @@ -46,11 +56,27 @@ Following inputs can be used as `step.with` keys | `file` | String | | File to compress (**required**) | | `args` | String | | Arguments to pass to UPX | +## Keep up-to-date with GitHub Dependabot + +Since [Dependabot](https://docs.github.com/en/github/administering-a-repository/keeping-your-actions-up-to-date-with-github-dependabot) +has [native GitHub Actions support](https://docs.github.com/en/github/administering-a-repository/configuration-options-for-dependency-updates#package-ecosystem), +to enable it on your GitHub repo all you need to do is add the `.github/dependabot.yml` file: + +```yaml +version: 2 +updates: + # Maintain dependencies for GitHub Actions + - package-ecosystem: "github-actions" + directory: "/" + schedule: + interval: "daily" +``` + ## Limitation This action is only available for Linux and Windows [virtual environments](https://help.github.com/en/articles/virtual-environments-for-github-actions#supported-virtual-environments-and-hardware-resources). -## How can I help ? +## How can I help? All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket: