add README

Author: alancolant

README.md

@@ -1 +1,47 @@
-# laravel-pulse-graphql
+
+<p align="center"><img src="./screenshot.png" alt="GraphQL tracking for Laravel Pulse"></p>
+
+# GraphQL requests in Laravel Pulse
+This package allow your to track all your GraphQL queries and mutations with rebing/graphql-laravel
+
+
+## Installation
+
+You can install the package via composer:
+
+```bash
+composer require alancolant/laravel-pulse-graphql
+```
+
+
+## Register the recorder
+
+Add the `GraphqlRecorder` inside `config/pulse.php`.
+
+(If you don\'t have this file make sure you have published the config file of Larave Pulse using `php artisan vendor:publish --tag=pulse-config`)
+
+```php
+return [
+    // ...
+
+    'recorders' => [
+        // Existing recorders...
+        
+        \Alancolant\PulseGraphql\Recorders\GraphqlRecorder::class => [], 
+    ]
+]
+```
+
+## Add to your dashboard
+
+To add the card to the Pulse dashboard, you must first [publish the vendor view](https://laravel.com/docs/10.x/pulse#dashboard-customization).
+
+```bash
+php artisan vendor:publish --tag=pulse-dashboard
+```
+
+Then, you can modify the `dashboard.blade.php` file and add the requests-graph livewire template:
+
+```php
+<livewire:pulse.graphql cols="6" />
+```