Skip to content

Commit c1e24a9

Browse files
authored
chore: update docs for 8.4 and update installaton methods (#35)
1 parent 7c409f4 commit c1e24a9

File tree

1 file changed

+10
-8
lines changed

1 file changed

+10
-8
lines changed

index.rst

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Supported PHP Versions
2121
* PHP 8.1
2222
* PHP 8.2
2323
* PHP 8.3
24+
* PHP 8.4
2425

2526
Documentation
2627
-------------
@@ -29,13 +30,14 @@ Installation
2930
~~~~~~~~~~~~
3031

3132
The recommended way to install PHP CS Fixer is to use
32-
`Composer <https://getcomposer.org/download/>`__ in a dedicated ``composer.json`` file in your project, for example in
33-
the ``tools/php-cs-fixer`` directory:
33+
`Composer <https://getcomposer.org/download/>`__:
3434

3535
.. code:: console
3636
37-
$ mkdir --parents tools/php-cs-fixer
38-
$ composer require --working-dir=tools/php-cs-fixer friendsofphp/php-cs-fixer
37+
$ composer require --dev friendsofphp/php-cs-fixer
38+
$ ## or when facing conflicts in dependencies:
39+
$ composer require --dev php-cs-fixer/shim
40+
3941
4042
For more details and other installation methods, see `installation instructions <./doc/installation.rst>`__.
4143

@@ -51,9 +53,9 @@ You can use pre-built Docker images to run ``php-cs-fixer``.
5153
5254
``$FIXER_VERSION`` used in example above is an identifier of a release you want to use, which is based on Fixer and PHP versions combined. There are different tags for each Fixer's SemVer level and PHP version with syntax ``<php-cs-fixer-version>-php<php-version>``. For example:
5355

54-
* ``3.47.0-php7.4``
55-
* ``3.47-php8.0``
56-
* ``3-php8.3``
56+
* ``3.80.0-php8.4``
57+
* ``3.80-php8.4``
58+
* ``3-php8.4``
5759

5860
Usage
5961
~~~~~
@@ -63,7 +65,7 @@ the following command to fix the files PHP files in the ``src`` directory:
6365

6466
.. code:: console
6567
66-
$ tools/php-cs-fixer/vendor/bin/php-cs-fixer fix src
68+
$ ./vendor/bin/php-cs-fixer fix src
6769
6870
See `usage <./doc/usage.rst>`__, list of `built-in rules <./doc/rules/index.rst>`__, list of `rule sets <./doc/ruleSets/index.rst>`__ and `configuration file <./doc/config.rst>`__ documentation for more
6971
details.

0 commit comments

Comments
 (0)