diff --git a/.github/readme/imgs/action_update.png b/.github/readme/imgs/action_update.png
new file mode 100644
index 00000000..837fba7e
Binary files /dev/null and b/.github/readme/imgs/action_update.png differ
diff --git a/.github/readme/imgs/github_profile.png b/.github/readme/imgs/github_profile.png
new file mode 100644
index 00000000..b1d22a8e
Binary files /dev/null and b/.github/readme/imgs/github_profile.png differ
diff --git a/.github/readme/imgs/personal_repo.png b/.github/readme/imgs/personal_repo.png
new file mode 100644
index 00000000..88d74873
Binary files /dev/null and b/.github/readme/imgs/personal_repo.png differ
diff --git a/docs/imgs/personal_token.png b/.github/readme/imgs/personal_token.png
similarity index 100%
rename from docs/imgs/personal_token.png
rename to .github/readme/imgs/personal_token.png
diff --git a/docs/imgs/personal_token_alt.png b/.github/readme/imgs/personal_token_alt.png
similarity index 100%
rename from docs/imgs/personal_token_alt.png
rename to .github/readme/imgs/personal_token_alt.png
diff --git a/.github/readme/imgs/plugin_lines.png b/.github/readme/imgs/plugin_lines.png
new file mode 100644
index 00000000..58c5c7f4
Binary files /dev/null and b/.github/readme/imgs/plugin_lines.png differ
diff --git a/.github/readme/imgs/plugin_pagespeed.png b/.github/readme/imgs/plugin_pagespeed.png
new file mode 100644
index 00000000..3784c05c
Binary files /dev/null and b/.github/readme/imgs/plugin_pagespeed.png differ
diff --git a/.github/readme/imgs/plugin_traffic.png b/.github/readme/imgs/plugin_traffic.png
new file mode 100644
index 00000000..69024fa4
Binary files /dev/null and b/.github/readme/imgs/plugin_traffic.png differ
diff --git a/.github/readme/imgs/repo_secrets.png b/.github/readme/imgs/repo_secrets.png
new file mode 100644
index 00000000..3cafae20
Binary files /dev/null and b/.github/readme/imgs/repo_secrets.png differ
diff --git a/.github/readme/imgs/token_repo_rights.png b/.github/readme/imgs/token_repo_rights.png
new file mode 100644
index 00000000..7c839852
Binary files /dev/null and b/.github/readme/imgs/token_repo_rights.png differ
diff --git a/README.md b/README.md
index 44e2718c..34dcabc9 100644
--- a/README.md
+++ b/README.md
@@ -32,11 +32,11 @@ Or with HTML :
If you don't know yet or haven't done it yet, create a repository with the same name as your GitHub username.
-
+
The `README.md` of this repository will be displayed on your GitHub user profile like below !
-
+
#### 1. Create a GitHub token
@@ -44,13 +44,13 @@ In your account settings, go to `Developer settings` and select `Personal access
You'll need to create a token with the `public_repo` right so this GitHub Action has enough permissions to push the updated SVG metrics on your personal repository.
-
+
#### 2. Put your GitHub token in your personal repository secrets
Go to the `Settings` of your personal repository to create a new secret and paste your GitHub token here with the name `METRICS_TOKEN`.
-
+
#### 3. Create a new GitHub Action workflow on your personal repo
@@ -116,7 +116,7 @@ The bot will be able to track metrics of all your public repositories.
If you want to also track your private repositories metrics, you'll need to pass a personal token with `repo` permissions to `token`, and use the `committer_token` parameter to pass the bot account token.
-
+
#### 4. Embed the link into your README.md
@@ -176,7 +176,7 @@ In your account settings, go to `Developer settings` and select `Personal access
As explained above, you do not need to grant additional permissions to the token.
-
+
#### 2. Install the dependancies
@@ -336,6 +336,19 @@ Edit your README.md on your repository and link it your image :
+
+⚠️ HTTP errors code
+
+The following errors code can be encountered if your using a server instance :
+
+* `403 Forbidden` : User is not whitelisted in `restricted` users list
+* `404 Not found` : GitHub API did not found the requested user
+* `429 Too many requests` : Thrown when rate limiter is trigerred
+* `500 Internal error` : An error ocurred while generating metrics images (logs can be seen if you're the owner of the instance)
+* `503 Service unavailable` : Maximum user capacity reached, only already cached images can be accessed for now
+
+
+
## 📚 Documentations
### 🧩 Plugins
@@ -348,7 +361,7 @@ These can provide more informations into your generated metrics, but it could al
The *pagespeed* plugin allows you to add your website performances.
-
+
These are computed through [Google's pagespeed API](https://developers.google.com/speed/docs/insights/v5/get-started), which returns the same results as [web.dev](https://web.dev).
@@ -393,7 +406,7 @@ And pass `?pagespeed=1` in url when generating metrics.
The *lines* plugin allows you to add the number of lines of code you added and removed across your repositories.
-
+
💬 About
@@ -431,7 +444,7 @@ And pass `?lines=1` in url when generating metrics.
The *traffic* plugin allows you to add the number of pages views across your repositories.
-
+
💬 About
@@ -440,7 +453,7 @@ It will consume an additional GitHub request per repository.
Due to GitHub Rest API limitation, the GitHub token you provide will requires "repo" permissions instead of "public_repo" to allow this plugin accessing traffic informations.
-
+
##### Setup with GitHub actions
@@ -522,16 +535,6 @@ Basically you create a `settings.json` containing a test token and `debug` mode
You can then start the node with `npm start` and you'll be able to test how the SVG renders with your editions by opening the server url in your browser.
-### ⚠️ HTTP errors code
-
-The following errors code can be encountered if your using a server instance :
-
-* `403 Forbidden` : User is not whitelisted in `restricted` users list
-* `404 Not found` : GitHub API did not found the requested user
-* `429 Too many requests` : Thrown when rate limiter is trigerred
-* `500 Internal error` : An error ocurred while generating metrics images (logs can be seen if you're the owner of the instance)
-* `503 Service unavailable` : Maximum user capacity reached, only already cached images can be accessed for now
-
### 📖 Useful references
Below is a list of useful links :
diff --git a/docs/imgs/action_update.png b/docs/imgs/action_update.png
deleted file mode 100644
index 8df68291..00000000
Binary files a/docs/imgs/action_update.png and /dev/null differ
diff --git a/docs/imgs/github_profile.png b/docs/imgs/github_profile.png
deleted file mode 100644
index 1093fce5..00000000
Binary files a/docs/imgs/github_profile.png and /dev/null differ
diff --git a/docs/imgs/personal_repo.png b/docs/imgs/personal_repo.png
deleted file mode 100644
index 4a18ae2c..00000000
Binary files a/docs/imgs/personal_repo.png and /dev/null differ
diff --git a/docs/imgs/plugin_lines.png b/docs/imgs/plugin_lines.png
deleted file mode 100644
index 46119bc0..00000000
Binary files a/docs/imgs/plugin_lines.png and /dev/null differ
diff --git a/docs/imgs/plugin_pagespeed.png b/docs/imgs/plugin_pagespeed.png
deleted file mode 100644
index e93b43c2..00000000
Binary files a/docs/imgs/plugin_pagespeed.png and /dev/null differ
diff --git a/docs/imgs/plugin_traffic.png b/docs/imgs/plugin_traffic.png
deleted file mode 100644
index a8b3e31d..00000000
Binary files a/docs/imgs/plugin_traffic.png and /dev/null differ
diff --git a/docs/imgs/repo_secrets.png b/docs/imgs/repo_secrets.png
deleted file mode 100644
index 7907165e..00000000
Binary files a/docs/imgs/repo_secrets.png and /dev/null differ
diff --git a/docs/imgs/token_repo_rights.png b/docs/imgs/token_repo_rights.png
deleted file mode 100644
index 849938c6..00000000
Binary files a/docs/imgs/token_repo_rights.png and /dev/null differ