From 01735859b06d187f0abdb761567a6ceaf530281b Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Fri, 11 Sep 2020 09:07:32 +0200 Subject: [PATCH] Update README.md --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3e1d3625..46e5cecc 100644 --- a/README.md +++ b/README.md @@ -12,12 +12,19 @@ Below is what it looks like : A GitHub Action which is run periodically at your convenience which generates and push an SVG image on your personal repository. -Assuming your username is `my-github-user`, you can embed your metrics like below : +Assuming your username is `my-github-user`, you can embed your metrics in your personal repository's readme like below : ```markdown -![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) +![GitHub metrics](github-metrics.svg) +# Or with a redirection : +[![GitHub metrics](github-metrics.svg)](https://github.com/my-github-user/my-github-user) ``` ```html -My GitHub metrics +My GitHub metrics +``` + +If you want to include it somewhere different from your personal repository, use the full link instead : +```markdown +![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) ```
@@ -75,12 +82,11 @@ Note that this will virtually increase your commits stats, so you could use a bo For conveniency, you can use the shared instance available at [metrics.lecoq.io](https://metrics.lecoq.io). -Assuming your username is `my-github-user`, you can embed your metrics like below : +Assuming your username is `my-github-user`, you can embed your metrics in your personal repository's readme like below : ```markdown ![GitHub metrics](https://metrics.lecoq.io/my-github-user) -``` -```html -My GitHub metrics +# Or with a redirection : +[![GitHub metrics](https://metrics.lecoq.io/my-github-user)](https://github.com/my-github-user/my-github-user) ```