more readme

This commit is contained in:
Robin Appelman 2025-10-26 14:13:32 +01:00
commit 9305bd7c85

View file

@ -5,9 +5,12 @@ An opinionated php module for
## Features ## Features
Included checks: The following checks are automatically enabled if your project contains the
relevant configuration files:
- php-cs-checker - php-cs-checker
- psalm
- phpstan
## Usage ## Usage
@ -24,3 +27,21 @@ Included checks:
flakelight-php ./. {}; flakelight-php ./. {};
} }
``` ```
## CI Usage
```yaml
name: "CI"
on:
pull_request:
push:
jobs:
checks:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: cachix/install-nix-action@v26
# insert cache setup here
- run: nix flake check --keep-going
```