Skip to content

Commit 1916e8b

Browse files
committed
update README
1 parent 29b9950 commit 1916e8b

File tree

1 file changed

+35
-12
lines changed

1 file changed

+35
-12
lines changed

README.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,26 @@ Générateur automatique de statistiques GitHub avec plusieurs variantes.
44

55
## 🎯 Résultat
66

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

911
- `stats-top2.svg` - Top 2 langages
1012
- `stats-top4.svg` - Top 4 langages
1113
- `stats-top6.svg` - Top 6 langages
14+
- `github-stats.svg` - Statistiques globale github
1215

1316
## 🚀 Installation
1417

15-
### 1. Créer le repository
18+
### 1. Cloner le repository
1619

1720
```bash
18-
# Créer un nouveau dépôt sur GitHub
19-
# Nom suggéré : github-stats
20-
21-
# Cloner et ajouter les fichiers
22-
git clone https://github.com/votre-username/github-stats.git
21+
# Cloner le projet
22+
git clone https://github.com/FabioDevCode/github-stats.git
2323
cd github-stats
24+
25+
# Supprimer les fichiers SVG existants (ils seront regénérés avec vos stats)
26+
rm -f *.svg
2427
```
2528

2629
### 2. Ajouter les fichiers
@@ -46,11 +49,21 @@ Dans `config.json`, modifiez les valeurs selon vos besoins :
4649
{
4750
"USERNAME": "votre-username",
4851
"TITLE": "Langages Utilisés",
52+
"STATS_TITLE": "GitHub Stats",
53+
"BG_COLOR": "#202830",
54+
"BORDER_COLOR": "#202830",
55+
"TITLE_COLOR": "#D1D7E0",
56+
"TEXT_COLOR": "#D1D7E0",
57+
"PERCENT_COLOR": "#9298A1",
58+
"ICON_COLOR": "#6e7681",
59+
"VALUE_COLOR": "#41B883",
4960
"VARIANTS": [2, 4, 6],
5061
"IGNORE_LANGUAGES": ["HTML", "CSS", "Handlebars", "SCSS"]
5162
}
5263
```
5364

65+
> 📝 **Note :** Consultez la section [Options disponibles](#options-disponibles) pour la description complète de chaque paramètre.
66+
5467
### 4. Créer un token GitHub
5568

5669
1. Allez sur GitHub → Settings → Developer settings → Personal access tokens → Tokens (classic)
@@ -102,9 +115,10 @@ Une fois déployé, vos images seront disponibles aux URLs :
102115
https://votre-username.github.io/github-stats/stats-top2.svg
103116
https://votre-username.github.io/github-stats/stats-top4.svg
104117
https://votre-username.github.io/github-stats/stats-top6.svg
118+
https://votre-username.github.io/github-stats/github-stats.svg
105119
```
106120

107-
> **Note :** Les fichiers générés dépendent de la configuration `VARIANTS` dans `config.json`.
121+
> **Note :** Les fichiers `stats-topN.svg` dépendent de la configuration `VARIANTS` dans `config.json`. Le fichier `github-stats.svg` affiche vos statistiques globales (stars, commits, PRs, issues, contributions).
108122
109123
### Dans un README :
110124

@@ -121,9 +135,12 @@ https://votre-username.github.io/github-stats/stats-top6.svg
121135
/>
122136
```
123137

124-
### Exemple :
138+
### Exemples :
125139

126-
<img src="https://fabiodevcode.github.io/github-stats/stats-top4.svg" alt="top 4 languages">
140+
<div style="display: inline-block" align="left">
141+
<img height="200px" src="https://fabiodevcode.github.io/github-stats/stats-top4.svg"/>
142+
<img height="200px" src="https://fabiodevcode.github.io/github-stats/github-stats.svg"/>
143+
</div>
127144

128145
## ⚙️ Configuration
129146

@@ -133,11 +150,14 @@ Toute la configuration se fait dans le fichier `config.json` :
133150
{
134151
"USERNAME": "votre-username",
135152
"TITLE": "Langages Utilisés",
153+
"STATS_TITLE": "GitHub Stats",
136154
"BG_COLOR": "#202830",
137155
"BORDER_COLOR": "#202830",
138156
"TITLE_COLOR": "#D1D7E0",
139157
"TEXT_COLOR": "#D1D7E0",
140158
"PERCENT_COLOR": "#9298A1",
159+
"ICON_COLOR": "#6e7681",
160+
"VALUE_COLOR": "#41B883",
141161
"VARIANTS": [2, 4, 6],
142162
"IGNORE_LANGUAGES": ["HTML", "CSS", "Handlebars", "SCSS"]
143163
}
@@ -148,12 +168,15 @@ Toute la configuration se fait dans le fichier `config.json` :
148168
| Option | Description | Exemple |
149169
| ------------------ | ------------------------------------ | --------------------- |
150170
| `USERNAME` | Votre nom d'utilisateur GitHub | `"FabioDevCode"` |
151-
| `TITLE` | Titre affiché sur l'image | `"Langages Utilisés"` |
171+
| `TITLE` | Titre du SVG des langages | `"Langages Utilisés"` |
172+
| `STATS_TITLE` | Titre du SVG des stats globales | `"GitHub Stats"` |
152173
| `BG_COLOR` | Couleur de fond | `"#202830"` |
153174
| `BORDER_COLOR` | Couleur de la bordure | `"#202830"` |
154175
| `TITLE_COLOR` | Couleur du titre | `"#D1D7E0"` |
155176
| `TEXT_COLOR` | Couleur du texte | `"#D1D7E0"` |
156-
| `PERCENT_COLOR` | Couleur des pourcentages | `"#9298A1"` |
177+
| `PERCENT_COLOR` | Couleur des pourcentages (langages) | `"#9298A1"` |
178+
| `ICON_COLOR` | Couleur des icônes (stats globales) | `"#6e7681"` |
179+
| `VALUE_COLOR` | Couleur des valeurs (stats globales) | `"#41B883"` |
157180
| `VARIANTS` | Variantes à générer (top N langages) | `[2, 4, 6, 8]` |
158181
| `IGNORE_LANGUAGES` | Langages à exclure des stats | `["HTML", "CSS"]` |
159182

0 commit comments

Comments
 (0)