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] 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
-
+
# Or with a redirection :
-[](https://github.com/my-github-user/my-github-user)
+[](https://github.com/my-github-user/my-github-user)
```
```html
```
-If you want to include it somewhere different from your personal repository, use the full link instead :
-```markdown
-
-```
-
-💬 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

+# 4. Embed the link into your README.md
+
+Edit your README.md on your repository and link it your image :
+
+```markdown
+
+```
+
### 💕 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
+
+```
+
## 🗂️ Project structure