Add Stargazers plugin (#37)
This commit is contained in:
43
README.md
43
README.md
@@ -147,20 +147,32 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="https://github.com/lowlighter/metrics#-stargazers">✨ Stargazers evolution</a></th>
|
||||
<th><a href="https://github.com/lowlighter/metrics#-stars">🌟 Recently starred repositories</a></th>
|
||||
<th><a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">🗃️ Header special features</a></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://github.com/lowlighter/metrics#-stargazers">
|
||||
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stargazers.svg" alt="" width="400">
|
||||
</a>
|
||||
</td>
|
||||
<td>
|
||||
<a href="https://github.com/lowlighter/metrics#-stars">
|
||||
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.stars.svg" alt="" width="400">
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th><a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">🗃️ Header special features</a></th>
|
||||
<th></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>
|
||||
<a href="https://github.com/lowlighter/metrics#%EF%B8%8F-base-content">
|
||||
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.header.svg" alt="" width="400">
|
||||
</a>
|
||||
</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td colspan="2" align="center">
|
||||
@@ -516,6 +528,7 @@ Used template defaults to the `classic` one.
|
||||
<th><span title="Habits">💡</span></th>
|
||||
<th><span title="Gists">🎫</span></th>
|
||||
<th><span title="Stars">🌟</span></th>
|
||||
<th><span title="Stargazers">✨</span></th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Classic</th>
|
||||
@@ -534,6 +547,7 @@ Used template defaults to the `classic` one.
|
||||
<td>✔️</td>
|
||||
<td>✔️</td>
|
||||
<td><span title="Available on master">✔️<sup>M</sup></span></td>
|
||||
<td><span title="Available on master">✔️<sup>M</sup></span></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Terminal</th>
|
||||
@@ -552,6 +566,7 @@ Used template defaults to the `classic` one.
|
||||
<td>❌</td>
|
||||
<td>✔️</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Repository<sup>R</sup></th>
|
||||
@@ -570,6 +585,7 @@ Used template defaults to the `classic` one.
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
<td>❌</td>
|
||||
<td><span title="Available on master">✔️<sup>M</sup></span></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
@@ -584,7 +600,7 @@ Used template defaults to the `classic` one.
|
||||
|
||||
To use `repository` template, you'll need to provide a repository name in `query` option.
|
||||
|
||||
If repository owner is different from `token` owner, use `user` option to specify it.
|
||||
If repository owner is different from `token` owner, use `user` option to specify it.
|
||||
|
||||
Add the following to your workflow :
|
||||
```yaml
|
||||
@@ -1281,6 +1297,29 @@ Add the following to your workflow :
|
||||
|
||||
</details>
|
||||
|
||||
### ✨ Stargazers
|
||||
|
||||
🚧 This feature is available on @master
|
||||
|
||||
The *stargazers* plugin displays your stargazers evolution across all of your repositories over the last two weeks.
|
||||
|
||||

|
||||
|
||||
<details>
|
||||
<summary>💬 About</summary>
|
||||
|
||||
It will consume additional GitHub requests per repository per set of 100 stargazers.
|
||||
|
||||
Add the following to your workflow :
|
||||
```yaml
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
# ... other options
|
||||
plugin_stargazers: yes
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
### 🔧 Other options
|
||||
|
||||
A few additional options are available.
|
||||
|
||||
Reference in New Issue
Block a user