From 9616296853a358a9244b715dad2a43e2a87c2852 Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Sun, 8 Sep 2019 12:53:33 +0530 Subject: [PATCH] Improve README.md (#6) * Improve README.md --- README.md | 44 ++++++++++++++++++++++++++++++-------------- 1 file changed, 30 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index ec99947b..261a9735 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,36 @@ -# setup-php +# Setup PHP in GitHub Actions

GitHub Actions status + LICENSE

-This action sets up a php environment along with composer and required PHP extensions on multiple platforms for use in github actions. +[GitHub Action](https://github.com/features/actions) to install PHP with required extensions and composer. This action can be added as a step in your action workflow and it will setup the PHP environment you need to test your application. Refer to [Usage](#usage) section to see how to use this. -# PHP Version Support +## PHP Versions Support - 5.6 - 7.0 - 7.1 - 7.2 - 7.3 -# Operating Systems Support -- Linux (ubuntu-latest) -- Windows (windows-latest) -- MacOS (macOS-latest) +## OS Support +- Linux `ubuntu-latest` +- Windows `windows-latest` +- MacOS `macOS-latest` -# PHP Extension Support +## PHP Extension Support - On linux extensions which have the package in apt are installed. - On Windows and MacOS pecl extensions are installed. - Extensions which are installed along with PHP if specified are enabled. - Extensions which cannot be installed gracefully leave an error message in the logs, the action is not interruped. -# Usage +## Usage See [action.yml](action.yml) -Basic: +### Basic + ```yaml steps: - name: Checkout @@ -46,7 +48,8 @@ steps: run: php -m ``` -Matrix Testing: +### Matrix Testing + ```yaml jobs: run: @@ -74,10 +77,23 @@ jobs: ``` -# License +## License The scripts and documentation in this project are released under the [MIT License](LICENSE) -# Contributions +## Contributions -Contributions are welcome! See [Contributor's Guide](docs/contributors.md) \ No newline at end of file +Contributions are welcome! See [Contributor's Guide](docs/contributors.md) + +## This action uses the following works + +- [powershell-phpmanager](https://github.com/mlocati/powershell-phpmanager) +- [Homebrew](https://brew.sh/) +- [ppa:ondrej/php](https://launchpad.net/~ondrej/+archive/ubuntu/php) +- [exolnet/homebrew-deprecated](https://github.com/eXolnet/homebrew-deprecated) + +## Further Reading + +- [About GitHub Actions](https://github.com/features/actions) +- [GitHub Actions Syntax](https://help.github.com/en/articles/workflow-syntax-for-github-actions) +- [Other Awesome Actions](https://github.com/sdras/awesome-actions)