Add details of the actions to the README

Author: shivammathur

LICENSE

@@ -0,0 +1,20 @@
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,3 +1,109 @@
 # php-windows-builder
 
-Build PHP and PECL extensions on Windows.
+This project provides actions to build PHP and its extensions on Windows.
+
+## Build PHP
+
+Build PHP for a specific version.
+
+```yaml
+- name: Build PHP
+  uses: php/php-windows-builder/php@v1
+  with:
+    php-version: '7.4.25'
+```
+
+### Inputs
+
+- `php-version` (required) - The PHP version to build. It supports values in major.minor.patch format, e.g. 7.4.25, 8.0.12, etc.
+
+### Outputs
+
+- `artifact-path` - The path to the artifacts produced by the action.
+
+The action will produce the following the following builds for the PHP version as artifacts.
+
+- nts-x64, nts-x64-AVX, ts-x64, nts-x86, ts-x86.
+- debug-pack and devel-pack for each the above configurations.
+- test pack
+
+## Build a PHP extension
+
+Build a PHP extension for a specific version.
+
+```yaml
+- name: Build the extension
+  uses: php/php-windows-builder/extension@v1
+  with:
+    extension-url: https://github.com/xdebug/xdebug # optional
+    extension-version: '3.3.1'
+    php-version: '7.4'
+  env:
+    CONFIGURE_ARGS: --enable-xdebug
+```
+
+### Inputs
+
+- `extension-url` (optional) - URL of the extension repository, defaults to the current repository.
+- `extension-version` (required) - The version of the extension to build.
+- `php-versions` (optional) - The PHP versions to build the extension for. It supports a comma-separated list of values in major.minor format, e.g. 7.4, 8.0, etc. It defaults to the range defined in the `package.xml`.
+
+### Outputs
+
+- `artifact-path` - The path to the artifacts produced by the action.
+
+The action will produce the following the following builds for the extension as artifacts.
+- nts-x64, ts-x64, nts-x86, ts-x86.
+
+## Release
+
+Upload the artifacts to the release.
+
+```yaml
+- name: Upload artifact to the release
+  uses: php/php-windows-builder/release@v1
+  with:
+    tag-name: ${{ github.event.release.tag_name }}
+  env:
+    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+### Inputs
+
+- `tag-name` (required) - The tag name of the release.
+
+### Example workflow to build and release an extension
+
+```yaml
+name: Build extension
+on:
+  release:
+    types: [published]
+  # create: # Uncomment this to run on tag/branch creation
+  # pull_request: # Uncomment this to run on pull requests  
+jobs:
+  build:
+    runs-on: windows-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Build the extension
+        uses: php/php-windows-builder/extension@v1
+        with:
+          extension-version: ${{ github.event.release.tag_name }}
+  release:
+    runs-on: ubuntu-latest
+    needs: build
+    if: ${{ github.event_name == 'release' }}
+    steps:
+      - name: Upload artifact to the release
+        uses: php/php-windows-builder/release@v1
+        with:
+          tag-name: ${{ github.event.release.tag_name }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## License
+
+The scripts and documentation in this project are released under the [MIT License](LICENSE)