Update README.md

README.md

@@ -6,4 +6,59 @@ pipeline_tag: text-generation
 library_name: transformers.js
 tags:
 - art
----
+---
+
+# Documentation du modèle Prenma-model ✨
+
+![bannière](http://www.image-heberg.fr/files/17576066292910236444.webp)
+
+Bienvenue sur la page de documentation de Prenma-model, un modèle JavaScript simple conçu pour la génération de noms et de pseudos uniques.
+
+## 🐱 Objectif du modèle
+Le modèle Prenma-model a pour unique fonction de générer des noms et des pseudos en se basant sur des paramètres donnés. Il peut créer des noms de style "fantasy" ou "réel", et ajouter des chiffres.
+
+Ce modèle ne nécessite pas d'entraînement et fonctionne entièrement côté client, ce qui le rend ultra-léger et rapide.
+
+## 🩷 Comment utiliser le modèle
+Tu peux utiliser ce modèle dans n'importe quel projet JavaScript en l'important directement depuis le Hugging Face Hub.
+
+## 🔥 Installation
+Il n'y a pas d'installation ! Tu as juste besoin d'accéder au fichier prenma.js depuis ton code.
+
+## 🐶 Exemples de code
+Voici comment appeler et utiliser le modèle :
+
+```
+import PrenmaModel from 'https://huggingface.co/Clemylia/Prenma-model/raw/main/prenma.js';
+
+// Crée une instance du modèle
+const prenmaModel = new PrenmaModel();
+
+// Exemple 1 : Générer un nom de fantasy de 10 lettres avec des chiffres
+const fantasyName = await prenmaModel.generate({
+  length: 10,
+  style: 'fantasy',
+  includeNumbers: true
+});
+console.log(fantasyName[0].generated_text); // Affiche le nom généré
+
+// Exemple 2 : Générer un nom réel sans chiffres
+const realName = await prenmaModel.generate({
+  style: 'real',
+  includeNumbers: false
+});
+console.log(realName[0].generated_text); // Affiche le nom généré
+```
+## ❤️ Ce que fait Prenma 
+
+° Prenma-model génère des noms et pseudos uniques a chaque génération 
+° Prenma-model génère un nom de la longueur que vous souhaitez en nombre de characteres/lettres,
+Vous l'avez l'option d'inclure des chiffres.
+
+## 🐉 La technique 
+
+Pour crée Prenma,
+Nous lui avons donné toutes les lettres de l'alphabet, et les chiffres,
+Et on lui a demandé de randomiser les lettres et les chiffres, en alternant les voyelles et les consonnes pour créé les noms !
+
+Les noms générer sont totalement libre d'utilisation !