Skip to content

Commit a010a33

Browse files
authored
Update README.md
1 parent 05739a7 commit a010a33

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Build](https://github.com/lowlighter/metrics/workflows/Build/badge.svg)
44

5-
Generates your metrics that you can embed everywhere !
5+
Generate your metrics that you can embed everywhere, including your GitHub profile readme !
66

77
[![Metrics](https://github.com/lowlighter/lowlighter/blob/master/metrics.classic.svg)](https://metrics.lecoq.io)
88

@@ -547,7 +547,7 @@ Used template defaults to the `classic` one.
547547
<td>✔️</td>
548548
</tr>
549549
<tr>
550-
<th>Repository<sup>MR</sup></th>
550+
<th>Repository<sup>R</sup></th>
551551
<td>✔️</td>
552552
<td>❌</td>
553553
<td>❌</td>
@@ -571,6 +571,25 @@ Used template defaults to the `classic` one.
571571
* **N** : Feature is already released, but new ones are available on `@master`
572572
* **R** : Repository template (all plugins content will be restricted to related repository)
573573

574+
<details>
575+
<summary>💬 Using repository template</summary>
576+
577+
To use `repository` template, you'll need to provide a repository name in `query` option.
578+
579+
If repository owner is different from `token` owner, use `user` option to specify it.
580+
581+
Add the following to your workflow :
582+
```yaml
583+
- uses: lowlighter/metrics@latest
584+
with:
585+
# ... other options
586+
template: repository
587+
user: "repository-owner"
588+
query: '{"repo":"repository-name"}'
589+
```
590+
591+
</details>
592+
574593
## 🧩 Plugins
575594

576595
Plugins are features which can provide additional metrics and features.

0 commit comments

Comments
 (0)