Merge pull request #30 from cgiupponi/improve-documentation

Update installation.md

Author: atmonshi

docs/getting-started/installation.md

@@ -11,17 +11,48 @@ Install @zeus Qr by running the following commands in your Laravel project direc
 composer require lara-zeus/qr
 ```
 
+## Migration
+
+Make sure to edit your resource migration to add the required columns.  
+The main one will be the same as your component; in the example below, it is set as `qr_code`.  
+If you want to store the personalization, another column is required; in the example, it is `options`.
+
+```php
+ Schema::create('ticket_replies', function (Blueprint $table) {
+    // other columns   
+    $table->string('qr_code');
+    $table->text('options');
+    // other columns
+});
+```
+
+## Cast
+
+The personalizations are stored as string but the component will use it as array so you need to tell to your model to cast it as array.
+
+```php
+class QrCode extends Model
+{
+    use HasFactory;
+
+    protected $casts = [
+        'options' => 'array'
+    ];
+}
+```
+
 ## Usage:
 
 use it in your resource
 
 ```php
 \LaraZeus\Qr\Components\Qr::make('qr_code')
-    // to open the designer as slide over instead of a modal
+    // to open the designer as slide over instead of a modal.
+    // Comment it out if you prefer the modal.
     ->asSlideOver()
 
-    //you can set the column you want to save the QR design options, you must cast it to array in your model
-    ->optionsColumn('string')
+    // you can set the column you want to save the QR design options, you must cast it to array in your model
+    ->optionsColumn('options')
 
     // set the icon for the QR action
     ->actionIcon('heroicon-s-building-library')
@@ -64,6 +95,18 @@ PopoverEntry::make('name')
     ->content(\LaraZeus\Qr\Facades\Qr::render(data:'dataOrUrl')),
 ```
 
+If you just want to print the QrCode in the InfoList you can use TextEntry with `formatStateUsing` method and pass the state and the $record as params.
+
+```php
+TextEntry::make('qr_code')
+    ->formatStateUsing(function (string $state, $record) {
+        return \LaraZeus\Qr\Facades\Qr::render(
+            data: $state,
+            options: $record->options // This is your model. We are passing the personalizations. If you want the default just comment it out.
+        );
+    }),
+```
+
 ### Usage with any action
 
 to use the QR code as an action in anywhere you want: