The great refactor (#82)
This commit is contained in:
26
source/plugins/traffic/README.md
Normal file
26
source/plugins/traffic/README.md
Normal file
@@ -0,0 +1,26 @@
|
||||
### 🧮 Repositories traffic
|
||||
|
||||
⚠️ This plugin requires a personal token with repo scope.
|
||||
|
||||
The repositories *traffic* plugin displays the number of page views across your repositories.
|
||||
|
||||
<table>
|
||||
<td align="center">
|
||||
<img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.traffic.svg">
|
||||
</td>
|
||||
</table>
|
||||
|
||||
Because of GitHub REST API limitation, provided token requires full `repo` scope to access traffic informations.
|
||||
|
||||

|
||||
|
||||
#### ℹ️ Examples workflows
|
||||
|
||||
[➡️ Available options for this plugin](metadata.yml)
|
||||
|
||||
```yaml
|
||||
- uses: lowlighter/metrics@latest
|
||||
with:
|
||||
# ... other options
|
||||
plugin_traffic: yes
|
||||
```
|
||||
Reference in New Issue
Block a user