Add README and sanitize example Wi-Fi credentials

2026-08-27 09:24:01 +02:00
parent 3c630a594d
commit 13b1f3d188
3 changed files with 39 additions and 3 deletions
@@ -0,0 +1,36 @@
+# QR Code Wi-Fi
+
+Générateur de QR code Wi-Fi 100 % statique, sans serveur ni build : on ouvre une page HTML, on renseigne le SSID et le mot de passe, et on obtient un QR code scannable ainsi qu'une fiche prête à imprimer pour des invités.
+
+## Fonctionnalités
+
+- Génération du QR code au format standard `WIFI:T:<type>;S:<ssid>;P:<password>;` directement dans le navigateur (bibliothèque [qrcodejs](https://github.com/davidshimjs/qrcodejs))
+- Édition en direct du SSID, du mot de passe et du type de sécurité (WPA/WEP/aucune)
+- Deux mises en page imprimables :
+  - **`classique.html`** — carte grand format, pensée pour un affichage à l'écran ou au mur
+  - **`a6.html`** — carte compacte au format 90 × 55 mm (proche d'une carte de visite), optimisée pour l'impression et la découpe
+- Aucune dépendance serveur, aucun build : 3 fichiers HTML autonomes
+
+## Utilisation
+
+1. Ouvrir `index.html` (ou directement `classique.html` / `a6.html`)
+2. Renseigner le SSID et le mot de passe du réseau à partager dans le formulaire
+3. Scanner le QR code avec un smartphone, ou cliquer sur **Imprimer** pour obtenir la fiche papier
+
+## Personnalisation
+
+Les valeurs par défaut sont modifiables de deux façons :
+
+- **à l'écran**, via le formulaire (non persistant, pratique pour un test rapide) ;
+- **en dur**, en tête de chaque fichier HTML (`WIFI_SSID`, `WIFI_PASSWORD`, `WIFI_DISPLAY_NAME`, `WIFI_SECURITY`), pour obtenir une fiche prête à l'emploi sans ressaisie à chaque ouverture.
+
+> ⚠️ Si vous renseignez vos vrais identifiants Wi-Fi dans le code, ne poussez pas ces fichiers sur un dépôt public — les valeurs par défaut de ce repo sont volontairement génériques.
+
+## Stack technique
+
+- HTML / CSS / JavaScript vanilla, aucune dépendance de build
+- [qrcodejs](https://github.com/davidshimjs/qrcodejs) chargé depuis un CDN pour le rendu du QR code
+
+## Déploiement
+
+Ces fichiers sont statiques : ils peuvent être ouverts directement dans un navigateur, ou servis par n'importe quel serveur web (Nginx, Apache, GitHub/Gitea Pages, etc.) sans configuration particulière.