diff --git a/README.md b/README.md index 3b388df..7172e15 100644 --- a/README.md +++ b/README.md @@ -5,11 +5,11 @@ [![Become a sponsor](https://img.shields.io/badge/sponsor-crazy--max-181717.svg?logo=github&style=flat-square)](https://github.com/sponsors/crazy-max) [![Paypal Donate](https://img.shields.io/badge/donate-paypal-00457c.svg?logo=paypal&style=flat-square)](https://www.paypal.me/crazyws) -## ✨ About +## About GitHub Action for [UPX](https://github.com/upx/upx), the Ultimate Packer for eXecutables. -## 🚀 Usage +## Usage Below is a simple snippet to use this action. A [live example](https://github.com/crazy-max/ghaction-upx/actions) is also available for this repository. @@ -36,7 +36,7 @@ jobs: args: -fq ``` -## 💅 Customizing +## Customizing ### inputs @@ -48,16 +48,16 @@ Following inputs can be used as `step.with` keys | `file` | String | | File to compress | | `args` | String | | Arguments to pass to UPX | -## :warning: Limitation +## 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: Thanks again for your support, it is much appreciated! :pray: -## 📝 License +## License MIT. See `LICENSE` for more details.