diff --git a/README.md b/README.md index f7f1fc11..1f52107f 100644 --- a/README.md +++ b/README.md @@ -15,8 +15,10 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste |[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.languages.svg)|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.followup.svg)|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.habits.svg)| | **Repositories traffic plugin** | **Lines of code plugin** | **Recent posts plugin** | |[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.traffic.svg)|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.lines.svg)| [](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.posts.svg)| -| **Isometric calendar plugin** | **Gists metrics plugin** | | -|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg)|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.gists.svg)| More to come soon ! | +| **Isometric calendar plugin** | **Gists metrics plugin** | **Starred topics plugin** | +|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.isocalendar.svg)|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.gists.svg)|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg)| +| | +| More to come soon ! | | Classic template | Terminal template | | | :----------------: | :----------------: | :----------------: | @@ -709,6 +711,37 @@ Add the following to your workflow : +#### 📌 Topics *Available in pre-release* + +The *topics* plugin allows you to display your [starred topics](https://github.com/stars?filter=topics). +Check out [GitHub topics](https://github.com/topics) to search interesting topics. + +![Gists plugin](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg) + +
+💬 About + +This uses puppeteer to navigate through your starred topics page. + +You can choose to display and order topics by : +- Most `stars` +- Recent `activity` +- Recently `starred` by you +- `random`ly + +Add the following to your workflow : +```yaml +- uses: lowlighter/metrics@latest + with: + # ... other options + plugin_topics: yes + plugin_topics_sort: stars + plugin_topics_limit: 15 +``` + +
+ + #### ⏭️ Selfskip The *selfskip* plugin allows you to count out all commits tagged with `[Skip GitHub Action]` you authored on your personal repository from your reported commit counts.