Voici un modèle de fichier README.md que vous pouvez utiliser pour votre projet @perfwatcher/core. Vous pouvez l'adapter selon vos besoins spécifiques.

# @perfwatcher/core

**Performance watcher for code execution tracking**

`@perfwatcher/core` est une bibliothèque conçue pour surveiller et analyser les performances du code d'exécution dans une application. Elle permet de suivre l'exécution des fonctions et de collecter des métriques pour optimiser les performances.

## Installation

Pour installer le package, exécutez la commande suivante :

```bash
npm install @perfwatcher/core

Utilisation

Exemple de base

import { watchFunction, performanceReport } from '@perfwatcher/core';

// Exemple d'une fonction à surveiller
function exampleFunction() {
  // Logic de la fonction
}

// Surveiller la fonction
const watchedFunction = watchFunction(exampleFunction);

// Appeler la fonction
watchedFunction();

// Afficher le rapport de performance
performanceReport();

Fonctionnalités

• Surveillance des fonctions : Permet de suivre l'exécution des fonctions et d'enregistrer des métriques de performance.
• Rapports détaillés : Affiche des rapports détaillés sur le temps d'exécution des fonctions surveillées.
• Analyse en temps réel : Permet une analyse en temps réel pendant l'exécution du code.

API

watchFunction(fn: Function) -> Function

Cette fonction permet de surveiller l'exécution d'une fonction. Elle retourne une version "surveillée" de la fonction, qui enregistre les métriques de performance lorsqu'elle est exécutée.

Paramètres :

• fn: La fonction à surveiller.

Retour :

• Une nouvelle fonction qui surveille l'exécution de la fonction d'origine.

performanceReport()

Affiche le rapport des métriques de performance collectées pendant l'exécution des fonctions surveillées.

Retour :

• Affiche un rapport dans la console avec des informations sur le temps d'exécution, le nombre d'appels, etc.

Développement

Pour démarrer en mode développement avec surveillance automatique des fichiers TypeScript, utilisez la commande suivante :

npm run dev

Cela lancera le compilateur TypeScript en mode watch et rechargera automatiquement le code lorsque des changements sont détectés.

Test

Pour exécuter les tests, vous pouvez utiliser la commande suivante :

npm test

Cela compilera les fichiers TypeScript et exécutera le script d'exemple pour vérifier que tout fonctionne correctement.

Contribuer

Si vous souhaitez contribuer à ce projet, veuillez forker le dépôt et soumettre une pull request avec vos améliorations. Nous apprécions toute aide pour améliorer ce projet !

Licence

Ce projet est sous licence MIT. Consultez le fichier LICENSE pour plus d'informations.

Si vous avez des questions ou des suggestions, n'hésitez pas à ouvrir une issue ou à nous contacter directement.

### Explication du contenu :

- **Titre et description** : Le nom du package et une brève explication de sa fonctionnalité.
- **Installation** : Instructions sur la manière d'installer la bibliothèque.
- **Exemple de base** : Un exemple simple pour montrer comment utiliser la bibliothèque.
- **Fonctionnalités** : Un résumé des principales fonctionnalités offertes par la bibliothèque.
- **API** : Documentation des principales fonctions et de leur utilisation.
- **Développement** : Instructions pour démarrer en mode développement avec une surveillance automatique des fichiers.
- **Test** : Instructions pour exécuter les tests.
- **Contribuer** : Un petit guide pour ceux qui veulent contribuer au projet.
- **Licence** : Mention de la licence (MIT) et lien vers le fichier de licence.

Si vous avez des détails supplémentaires à inclure ou souhaitez adapter ce modèle, n'hésitez pas à le modifier.