galadrim-feedback 0.0.62 → 0.0.64

package/README.md

@@ -1,22 +1,73 @@
-Installation
+# Installation Guide for Galadrim Feedback
 
-Pré-requis :
-axios
+## Prérequis
 
-yarn add galadrim-feedback axios
+Avant d'installer **Galadrim Feedback**, assurez-vous d'avoir **axios** installé dans votre projet.
 
-ajouter "babel-plugin-react-generate-paths" comme plugin babel
+```bash
+yarn add axios
+```
 
-add the FeedbackRoot to the root of your app (it needs to be inside the router)
+Ensuite, installez **Galadrim Feedback** :
 
+```bash
+yarn add galadrim-feedback
+```
+
+## Configuration Babel
+
+Ajoutez le plugin **babel-plugin-react-generate-paths** dans votre configuration Babel.
+
+### Option 1: Dans `vite.config.ts`
+
+Si vous utilisez Vite, ajoutez le plugin dans le fichier `vite.config.ts` comme suit :
+
+```typescript
+import { defineConfig } from "vite";
+import react from "@vitejs/plugin-react";
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [
+    react({
+      babel: {
+        plugins: [["babel-plugin-react-generate-paths"]],
+      },
+    }),
+  ],
+});
+```
+
+### Option 2: Dans `.babelrc`
+
+Si vous utilisez un fichier `.babelrc`, ajoutez le plugin dans la section `plugins` :
+
+```json
+{
+  "plugins": ["babel-plugin-react-generate-paths"]
+}
+```
+
+## Intégration de FeedbackRoot
+
+Ajoutez le composant **FeedbackRoot** à la racine de votre application. Il doit être placé à l'intérieur du **router**.
+
+```javascript
 import FeedbackRoot from "galadrim-feedback";
-import "galadrim-feedback/dist/styles.css";
+import "galadrim-feedback/dist/styles.css"; // N'oubliez pas d'importer les styles CSS
 
-add the following props to the FeedbackRoot component :
+// Ajoutez FeedbackRoot à votre application
 <FeedbackRoot
-rootDir="/path/to/your/project"
-projectId="your-project-id"
-navigate={(path) => navigate(path)}
-/>
+  rootDir="/path/to/your/project"
+  projectId="your-project-id" // L'id de votre projet dans Galadmin
+  navigate={(path) => navigate(path)} // Fonction de navigation pour utiliser votre router
+/>;
+```
+
+### Explication des Props :
+
+- **rootDir** : Le chemin vers la racine de votre projet.
+- **projectId** : L'identifiant de votre projet dans **Galadmin**.
+- **navigate** : Une fonction qui prend un chemin et vous permet de naviguer en utilisant votre **router**.
 
-navigate is a function that takes a path and navigates to it using your router
+Cela conclut l'installation de **Galadrim Feedback** dans votre projet !