From e8e66a6ba8cd1ee07d0ef13d79d3a3f052315b4b Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Thu, 10 Sep 2020 22:40:22 +0200 Subject: [PATCH 1/4] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 678a2f81..3e1d3625 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,7 @@ Paste the following and don't forget to put your GitHub username. name: GitHub metrics as SVG image on: # Update metrics each 15 minutes. Edit this if you want to increase/decrease frequency + # Note that GitHub image cache (5-15 minutes) still apply so it is useless to set less than this, you're image won't be refreshed schedule: [{cron: "*/15 * * * *"}] # Add this if you want to force update each time you commit on master branch push: {branches: "master"} 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 2/4] 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) ```
From 9f6ab99ec13a0be54b853514c947751143423902 Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Fri, 11 Sep 2020 12:44:18 +0200 Subject: [PATCH 3/4] Update README.md --- README.md | 27 +++++++++++++++++++-------- 1 file changed, 19 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 46e5cecc..d16b3cee 100644 --- a/README.md +++ b/README.md @@ -14,21 +14,16 @@ A GitHub Action which is run periodically at your convenience which generates an Assuming your username is `my-github-user`, you can embed your metrics in your personal repository's readme like below : ```markdown -![GitHub metrics](github-metrics.svg) +![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) # Or with a redirection : -[![GitHub metrics](github-metrics.svg)](https://github.com/my-github-user/my-github-user) +[![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg)](https://github.com/my-github-user/my-github-user) ``` ```html 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) -``` -
-💬 How to setup in 3 steps +💬 How to setup ? ### 1. Create a GitHub token @@ -76,6 +71,14 @@ Note that this will virtually increase your commits stats, so you could use a bo ![Action update](https://github.com/lowlighter/metrics/blob/master/docs/imgs/action_update.png) +# 4. Embed the link into your README.md + +Edit your README.md on your repository and link it your image : + +```markdown +![GitHub metrics](https://github.com/my-github-user/my-github-user/blob/master/github-metrics.svg) +``` +
### 💕 Using the shared instance (~2 min setup, but with limitations) @@ -247,6 +250,14 @@ Check if your service is up and running : systemctl status github_metrics ``` +# 6. Embed the link into your README.md + +Edit your README.md on your repository and link it your image : + +```markdown +![GitHub metrics](https://my-personal-domain.com/my-github-user) +``` +
## 🗂️ Project structure From b7e49e63c71f7f08602eaa23a510303f043ab47e Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Fri, 11 Sep 2020 12:45:21 +0200 Subject: [PATCH 4/4] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d16b3cee..6f24e9db 100644 --- a/README.md +++ b/README.md @@ -81,7 +81,7 @@ Edit your README.md on your repository and link it your image :
-### 💕 Using the shared instance (~2 min setup, but with limitations) +### 💕 Using the shared instance (~1 min setup, but with limitations) For conveniency, you can use the shared instance available at [metrics.lecoq.io](https://metrics.lecoq.io). @@ -116,7 +116,7 @@ It is also easier to change `query.graphql`, `style.css` and `template.svg` if y
-💬 How to setup in 5 steps +💬 How to setup ? ### 0. Prepare your server