Update README.md

This commit is contained in:
Simon Lecoq
2020-09-11 12:44:18 +02:00
committed by GitHub
parent 01735859b0
commit 9f6ab99ec1

View File

@@ -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 : Assuming your username is `my-github-user`, you can embed your metrics in your personal repository's readme like below :
```markdown ```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 : # 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 ```html
<img src="github-metrics.svg" alt="My GitHub metrics"> <img src="github-metrics.svg" alt="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)
```
<details> <details>
<summary>💬 How to setup in 3 steps</summary> <summary>💬 How to setup ?</summary>
### 1. Create a GitHub token ### 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) ![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)
```
</details> </details>
### 💕 Using the shared instance (~2 min setup, but with limitations) ### 💕 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 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)
```
</details> </details>
## 🗂️ Project structure ## 🗂️ Project structure