react-mada-location/README.md

Composants React pour la sélection géographique à Madagascar (provinces, régions, districts).

Voici une version améliorée du README pour ta bibliothèque `react-mada-location` :

---

# react-mada-location

**react-mada-location** est une bibliothèque JavaScript/React dédiée à la gestion et à l'affichage de données géographiques spécifiques à Madagascar, en particulier les délimitations administratives. Elle offre une série de composants réutilisables pour afficher et manipuler des données géographiques de manière dynamique dans vos applications React.

## Table des matières
- [Description](#description)
- [Installation](#installation)
- [Utilisation](#utilisation)
  - [Exemples de Composants](#exemples-de-composants)
- [Développement](#développement)
- [Contribuer](#contribuer)
- [Licence](#licence)
- [Voir le dépôt GitHub](#voir-le-dépôt-github)

## Description

**react-mada-location** fournit des composants React pour afficher et manipuler les données géographiques de Madagascar, y compris les **provinces**, **régions**, **districts**, et autres informations géographiques administratives. Cette bibliothèque est construite avec **React** et **Vite**, et elle est optimisée pour une intégration simple dans n'importe quelle application React.

### Fonctionnalités principales :
- Composants React pour afficher des **listes déroulantes**, des **cases à cocher** et des **groupes radio** en fonction des données géographiques de Madagascar.
- Données géographiques réactives et faciles à manipuler.
- Installation et intégration simples dans un projet React via **npm** ou **yarn**.
- Facilité d'extension et de personnalisation pour vos besoins spécifiques.

## Installation

Pour installer la bibliothèque et l'utiliser dans votre projet React, exécutez la commande suivante dans votre terminal :

### Avec npm :
```bash
npm install react-mada-location
```

### Avec yarn :
```bash
yarn add react-mada-location
```

## Utilisation

Une fois la bibliothèque installée, vous pouvez commencer à l'utiliser dans votre application React. Voici un exemple de comment intégrer les composants de `react-mada-location` :

### Exemple de composant ProvinceDropdown :
```jsx
import React from 'react';
import { ProvinceDropdown } from 'react-mada-location';

function MyApp() {
  return (
    <div>
      <h1>Choisissez une province</h1>
      <ProvinceDropdown />
    </div>
  );
}

export default MyApp;
```

### Exemples de Composants :
- `ProvinceDropdown` : Affiche une liste déroulante des provinces de Madagascar.
- `RegionByProvinceDropdown` : Affiche les régions d'une province donnée.
- `DistrictByRegionCheckboxList` : Affiche une liste de districts sous forme de cases à cocher.

## Développement

### Lancer en mode développement :
Pour développer et tester la bibliothèque localement, vous pouvez exécuter la commande suivante après avoir cloné le dépôt :

```bash
npm run dev
```

Cela lancera un serveur local avec hot-reloading pour voir les modifications en temps réel.

## Contribuer

Vous pouvez contribuer à ce projet en ouvrant des **issues** ou en soumettant des **pull requests**. Si vous avez une fonctionnalité ou une amélioration à proposer, n'hésitez pas à créer une **issue** sur le [dépôt GitHub](https://github.com/GloFlav).

### Comment contribuer :
1. Fork le dépôt.
2. Crée une branche pour ta fonctionnalité.
3. Fais tes changements, puis commit-les.
4. Push ta branche.
5. Crée une pull request.

## Licence

Ce projet est sous la licence [MIT](LICENSE).

## Voir le dépôt GitHub

Tu peux consulter le dépôt GitHub pour plus d'informations, le code source, et pour suivre l'évolution de la bibliothèque :
[Voir le dépôt GitHub](https://github.com/GloFlav/mada-geo-data)