Update README.md
This commit is contained in:
27
README.md
27
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
|
||||
<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
|
||||

|
||||
```
|
||||
|
||||
<details>
|
||||
<summary>💬 How to setup in 3 steps</summary>
|
||||
<summary>💬 How to setup ?</summary>
|
||||
|
||||
### 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
|
||||

|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### 💕 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
|
||||

|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
## 🗂️ Project structure
|
||||
|
||||
Reference in New Issue
Block a user