📝 improve docs and CI

.github/workflows/build.yaml

@@ -32,6 +32,10 @@ jobs:
                       php: '8.1'
                     - description: 'No Symfony specified'
                       php: '8.2'
+                    - description: 'No Symfony specified'
+                      php: '8.3'
+                    - description: 'No Symfony specified'
+                      php: '8.4'
                     - description: 'Lowest deps'
                       php: '8.1'
                       composer_option: '--prefer-lowest'
@@ -41,11 +45,11 @@ jobs:
                       php: '8.1'
                       symfony: 5.4.*
                     - description: 'Symfony 6.4'
-                      php: '8.2'
+                      php: '8.3'
                       symfony: 6.4.*
                     - description: 'Latest'
-                      php: '8.3'
-                      symfony: 7.0.*
+                      php: '8.4'
+                      symfony: 7.1.*
         name: PHP ${{ matrix.php }} tests (${{ matrix.description }})
         steps:
             - name: Checkout

composer.json

@@ -28,7 +28,7 @@
         "symfony/http-kernel": "^5.4 || ^6.0 || ^7.0"
     },
     "require-dev": {
-        "phpunit/phpunit": "^10.5 || ^11.3"
+        "phpunit/phpunit": "^10.5 || ^11.5"
     },
     "config": {
         "bin-dir": "bin",

docs/index.md

@@ -1,27 +1,15 @@
-Documentation
-=============
+# Documentation
 
 ## Installation
 
-Run from terminal:
+Run from a terminal:
 
 ```bash
-$ composer require pugx/shortid-doctrine-bundle
+composer require pugx/shortid-doctrine-bundle
 ```
 
-If you don't use Flex, you need to manually enable bundle in your kernel:
-
-```php
-<?php
-// app/AppKernel.php
-public function registerBundles()
-{
-    $bundles = [
-        // ...
-        new PUGX\Shortid\Doctrine\Bundle\PUGXShortidDoctrineBundle(),
-    ];
-}
-```
+The bundle should be automatically enabled and configured by Flex.
+If not, remember to enable the bundle in you kernel.
 
 ## Usage
 
@@ -34,19 +22,16 @@ Example:
 namespace App\Entity;
 
 use Doctrine\ORM\Mapping as ORM;
+use PUGX\Shortid\Doctrine\Generator\ShortidGenerator;
 
-/**
- * @ORM\Entity()
- * @ORM\Table()
- */
+#[ORM\Entity]
+#[ORM\Table]
 class Book
 {
-    /**
-     * @ORM\Column(type="shortid")
-     * @ORM\Id
-     * @ORM\GeneratedValue(strategy="CUSTOM")
-     * @ORM\CustomIdGenerator(class="PUGX\Shortid\Doctrine\Generator\ShortidGenerator")
-     */
+    #[ORM\Column(type: 'shortid')
+    #[ORM\Id]
+    #[ORM\GeneratedValue(strategy: 'CUSTOM')
+    #[ORM\CustomIdGenerator(class: ShortidGenerator::class)
     protected $id;
 }
 ```
@@ -62,13 +47,13 @@ pugx_shortid_doctrine:
         alphabet: "é123456789àbcdefghìjklmnòpqrstùvwxyzABCDEFGHIJKLMNOPQRSTUVWX.!@|"
 ```
 
-The `length` option must be between 2 and 20 (default is 7), while `alphabet` must be 64 characters long.
+The `length` option must be between 2 and 20 (the default value is 7), while the `alphabet` must be 64 characters long.
 
->Be aware: if you change `length` in this way, you **must** specify `length` option in every column definition.
->Moreover, you'll need to manually set column definition for ManyToOne mappings.
+>Be aware: if you change the `length` in this way, you **must** specify the `length` option in every column definition.
+>Moreover, you'll need to manually set the column definition for ManyToOne mappings.
 >For example: `<join-column column-definition="CHAR(8) COLLATE utf8_bin NOT NULL"/>`
 
-You can also configure `readable` option instead of `alphabet`. Example:
+You can also configure the `readable` option instead of `alphabet`. Example:
 
 ```yaml
 pugx_shortid_doctrine: