Skip to content

Commit 27004d3

Browse files
committed
docs: Add date format link and example
1 parent c7a951a commit 27004d3

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ If the `theme` parameter is specified, any color customizations specified will b
6161
| Parameter | Details | Example |
6262
| :---------------: | :--------------------------------------------: | :---------------------------------------------------: |
6363
| `user` | GitHub username to show stats for | `DenverCoder1` |
64-
| `date_format` | Date format (Default: `M j[, Y]`) | See note below on format strings |
64+
| `date_format` | Date format (Default: `M j[, Y]`) | See note below on [Date Formats](#date-formats) |
6565
| `theme` | The theme to apply (Default: `default`) | `dark`, `radical`, etc. [🎨➜](./docs/themes/README.md) |
6666
| `hide_border` | Make the border transparent (Default: `false`) | `true` or `false` |
6767
| `background` | Background color | **hex code** without `#` or **css color** |
@@ -93,6 +93,12 @@ When the contribution year is equal to the current year, the characters in brack
9393
| <pre>[Y.]n.j</pre> | <pre>"2020-04-14" => "2020.4.14"<br/><br/>"2021-04-14" => "4.14"</pre> |
9494
| <pre>M j[, Y]</pre> | <pre>"2020-04-14" => "Apr 14, 2020"<br/><br/>"2021-04-14" => "Apr 14"</pre> |
9595

96+
### Example
97+
98+
```md
99+
[![GitHub Streak](https://github-readme-streak-stats.herokuapp.com/?user=denvercoder1&currStreakNum=2FD3EB&fire=pink&sideLabels=F00&date_format=[Y.]n.j)](https://git.io/streak-stats)
100+
```
101+
96102
## ℹ️ How these stats are calculated
97103

98104
This tool uses the contribution graphs on your GitHub profile to calculate which days you have contributed.

0 commit comments

Comments
 (0)