update README

.github/workflows/php.yml → .github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: phpgeo Tests
+name: phpgeo CI Tasks
 
 on:
   push:
@@ -22,15 +22,15 @@ jobs:
           - "8.1"
           - "8.2"
 
-    name: "phpgeo build - PHP ${{ matrix.php-versions }}"
+    name: "phpgeo CI run - PHP ${{ matrix.php-versions }}"
 
     steps:
       - uses: actions/checkout@v3
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php-versions }}
+          php-version: "${{ matrix.php-versions }}"
           coverage: xdebug
 
       - name: Validate composer.json and composer.lock
@@ -41,7 +41,7 @@ jobs:
         uses: actions/cache@v3
         with:
           path: vendor
-          key: ${{ runner.os }}-php-${{ matrix.php-versions }}-${{ hashFiles('composer.json') }}
+          key: "${{ runner.os }}-php-${{ matrix.php-versions }}-${{ hashFiles('composer.json') }}"
           restore-keys: |
             ${{ runner.os }}-php-${{ matrix.php-versions }}-
 

README.md

@@ -17,6 +17,7 @@ phpgeo provides abstractions to geographical coordinates (including support for
   - [Requirements](#requirements)
   - [Documentation](#documentation)
   - [Installation](#installation)
+  - [Upgrading](#upgrading)
   - [License](#license)
   - [Features](#features)
   - [Examples/Usage](#examplesusage)
@@ -29,7 +30,7 @@ phpgeo provides abstractions to geographical coordinates (including support for
       - [GeoJSON](#geojson)
   - [Development](#development)
     - [Run Tests](#run-tests)
-  - [Miscellaneous](#miscellaneous)
+    - [Running GitHub Actions locally](#running-github-actions-locally)
   - [Credits](#credits)
 
 <!-- /MarkdownTOC -->
@@ -263,6 +264,14 @@ Psalm:
 ./vendor/bin/psalm
 ```
 
+### Running GitHub Actions locally
+
+It's possible to run the whole CI test matrix locally with *[act](https://github.com/nektos/act)*:
+
+```shell
+act --rm -P ubuntu-latest=shivammathur/node:latest
+```
+
 ## Credits
 
 * Marcus Jaschen <[email protected]> and [all contributors](https://github.com/mjaschen/phpgeo/graphs/contributors)