Skip to content

Commit 1922a8d

Browse files
committed
feat: update config & README
1 parent e53d0ec commit 1922a8d

File tree

2 files changed

+16
-12
lines changed

2 files changed

+16
-12
lines changed

README.md

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# GitHub Stats Generator
22

3-
Générateur automatique de statistiques GitHub avec plusieurs variantes.
3+
Générez automatiquement des images SVG de vos statistiques GitHub et intégrez-les dans n'importe quel README.
4+
5+
Ce projet fonctionne entièrement via **GitHub Actions** : aucune installation locale requise. Les images sont générées automatiquement selon la fréquence de votre choix et hébergées sur **GitHub Pages**, accessibles par URL publique.
46

57
## 🎯 Résultat
68

7-
Ce projet génère automatiquement des images SVG affichant, vos statistiques github et langages les plus utilisés.
9+
Ce projet génère automatiquement des images SVG affichant vos statistiques GitHub et les langages les plus utilisés.
810

911
- `stats-top4.svg` - Top 4 langages
10-
- `github-stats.svg` - Statistiques globale github
12+
- `github-stats.svg` - Statistiques globales GitHub
1113

1214
### Exemples :
1315

@@ -29,9 +31,9 @@ cd github-stats
2931
rm -f *.svg
3032
```
3133

32-
### 2. Ajouter les fichiers
34+
### 2. Vérifier la structure du projet
3335

34-
Créez la structure suivante :
36+
Après le clone, vérifiez que la structure suivante est bien présente :
3537

3638
```
3739
github-stats/
@@ -51,7 +53,7 @@ Dans `config.json`, modifiez les valeurs selon vos besoins :
5153
```json
5254
{
5355
"USERNAME": "votre-username",
54-
"TITLE": "Langages Utilisés",
56+
"TITLE": "Top Languages",
5557
"STATS_TITLE": "GitHub Stats",
5658
"BG_COLOR": "#202830",
5759
"BORDER_COLOR": "#202830",
@@ -150,7 +152,7 @@ Toute la configuration se fait dans le fichier `config.json` :
150152
```json
151153
{
152154
"USERNAME": "votre-username",
153-
"TITLE": "Langages Utilisés",
155+
"TITLE": "Top Languages",
154156
"STATS_TITLE": "GitHub Stats",
155157
"BG_COLOR": "#202830",
156158
"BORDER_COLOR": "#202830",
@@ -183,7 +185,7 @@ Toute la configuration se fait dans le fichier `config.json` :
183185

184186
### Changer la fréquence de mise à jour
185187

186-
Dans `.github/workflows/update-stats.yml`, modifiez la ligne cron :
188+
Dans `.github/workflows/update-stats.yml`, remplacez la valeur `cron` par l'une des options suivantes selon vos besoins :
187189

188190
```yaml
189191
schedule:
@@ -192,6 +194,8 @@ schedule:
192194
- cron: "0 0 * * 1" # Tous les lundis
193195
```
194196
197+
> 💡 La fréquence par défaut est définie dans ce fichier. Conservez une seule ligne `- cron:` active à la fois.
198+
195199
### Couleurs des langages
196200

197201
Les couleurs des langages sont définies dans `github_colors.json`. Ce fichier contient les couleurs officielles GitHub pour chaque langage. Vous pouvez le modifier si nécessaire.
@@ -208,7 +212,7 @@ Les couleurs des langages sont définies dans `github_colors.json`. Ce fichier c
208212

209213
1. Attendez 2-3 minutes après le premier push (déploiement GitHub Pages)
210214
2. Vérifiez que GitHub Pages est activé dans Settings
211-
3. Vérifiez l'URL : `https://votre-username.github.io/nom-du-repo/stats.svg`
215+
3. Vérifiez l'URL : `https://votre-username.github.io/nom-du-repo/stats-top4.svg`
212216

213217
### Forcer une mise à jour manuelle
214218

@@ -218,8 +222,8 @@ Les couleurs des langages sont définies dans `github_colors.json`. Ce fichier c
218222

219223
## 📄 Licence
220224

221-
Ce projet est libre d'utilisation pour votre usage personnel.
225+
Ce projet est distribué sous licence [MIT](LICENSE). Vous êtes libre de l'utiliser, le modifier et le redistribuer.
222226

223227
---
224228

225-
**Note :** Les statistiques sont mises à jour automatiquement chaque Lundi. Les repositories forkés sont exclus du calcul.
229+
**Note :** Les dépôts forkés sont exclus du calcul des statistiques. La fréquence de mise à jour est configurable, voir la section [Changer la fréquence de mise à jour](#changer-la-fréquence-de-mise-à-jour).

config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"USERNAME": "FabioDevCode",
3-
"TITLE": "Langages Utilisés",
3+
"TITLE": "Top Languages",
44
"STATS_TITLE": "GitHub Stats",
55
"BG_COLOR": "#202830",
66
"BORDER_COLOR": "#202830",

0 commit comments

Comments
 (0)