diff --git a/.changelog/current-readme-installation.md b/.changelog/current-readme-installation.md new file mode 100644 index 0000000..56be606 --- /dev/null +++ b/.changelog/current-readme-installation.md @@ -0,0 +1,7 @@ +--- +category: changed +type: patch +--- + +Describes current usage and installs the compatible Composer package without a +fixed release in the README example. diff --git a/README.md b/README.md index e705848..20eaffc 100644 --- a/README.md +++ b/README.md @@ -8,9 +8,9 @@ [![GitHub Sponsors](https://img.shields.io/github/sponsors/php-fast-forward?color=EC4899)](https://github.com/sponsors/php-fast-forward) Focused PHP style and static syntax checks, independent of DevTools. The library -provides an extendable ECS PER Coding Style 3.0 preset; the CLI checks tracked PHP files or the files -changed by an exact PR head. This initial increment validates PHP syntax and -style, not type correctness, application behavior or coverage. +provides an extendable ECS PER Coding Style 3.0 preset; the CLI checks tracked PHP +files or the files changed by an exact PR head. It validates PHP syntax and style; +type analysis, application tests and coverage belong to their respective tools. ## ✨ Features @@ -25,18 +25,17 @@ style, not type correctness, application behavior or coverage. Install the published development tool in your Git project: ```sh -composer require --dev fast-forward/code-standards:^0.1 --no-plugins --no-scripts +composer require --dev fast-forward/code-standards vendor/bin/code-standards check --all ``` -The verified first release is `v0.1.0`; select a compatible version deliberately. -The separate GitHub `v0` workflow channel can advance across development minors. +The GitHub `v0` workflow channel and the Composer package are separate +distribution mechanisms. - -Requires PHP 8.3+, Git and Composer runtime API 2.2+ for installed binary proxies. -Composer resolves the tool runtime independently from -the consumer application's PHP minimum; syntax is checked using the executing -PHP binary. No PHP migration rules are enabled. Review compatibility with the +Requires PHP 8.3 or later in the 8.x series, Git and Composer runtime API 2.2+ +for installed binary proxies. Composer resolves the tool with the project's +dependency constraints; syntax is checked using the executing PHP binary. +No PHP migration rules are enabled. Review compatibility with the application's minimum PHP before adopting a preset. Workflow guards and their contributor tests additionally require Bash and jq. @@ -47,7 +46,7 @@ Composer exposes the portable skill through `extra.skills.source` at `resources/skills`. `llm/skills` is an optional consumer integration; installation and activation are explicit. The development `check` script validates Composer metadata and the actual platform before running this package's tests and style -check. Operational channel dependencies remain development-only. +check. For a reviewed source checkout: @@ -85,11 +84,9 @@ conflicting scan modes and unsupported arguments are rejected explicitly. ## ⚙️ Configuration and extension -Install `fast-forward/code-standards` as development tooling. Select the reviewed -Composer version and workflow/runtime refs independently and deliberately. For -an isolated source trial, a local Composer path repository may require `*@dev` -with plugins/scripts disabled; that constraint describes the checkout, not a -published release. +Install `fast-forward/code-standards` as development tooling. Select the Composer +package and workflow/runtime refs independently: Composer resolves package +dependencies, while the GitHub workflow uses its reviewed ref. ```php