From d63866a759ce1fb94db374f3c15b2a1265be207c Mon Sep 17 00:00:00 2001 From: Simon Lecoq <22963968+lowlighter@users.noreply.github.com> Date: Tue, 8 Dec 2020 19:23:53 +0100 Subject: [PATCH] Update README.md --- README.md | 46 ++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 42 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3d03ed29..feb04942 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,8 @@ But there's more with [plugins](https://github.com/lowlighter/metrics/tree/maste |[](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** | **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 ! | +| **Projects plugin** | | +|[](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.projects.svg)| More to come soon ! | | Classic template | Terminal template | | | :----------------: | :----------------: | :----------------: | @@ -711,12 +711,12 @@ Add the following to your workflow : -### 📌 Topics *(pre-release)* +### 📌 Topics 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) +![Topics plugin](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.topics.svg)
💬 About @@ -741,6 +741,44 @@ Add the following to your workflow :
+### 📌 Projects + +The *projects* plugin allows you to display your profile projects. + +![Projects plugin](https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.projects.svg) + +
+💬 About + +It will consume an additional GitHub request. + +Add the following to your workflow : +```yaml +- uses: lowlighter/metrics@latest + with: + # ... other options + plugin_projects: yes + plugin_projects_limit: 4 +``` + +Note that by default, projects created have progress tracking disabled. +To enable it, open the `≡ Menu` and edit the project to check `Track project progress` (this can be confusing because it's actually not in the project settings). + +![Image](https://github.com/lowlighter/metrics/blob/master/.github/readme/imgs/plugin_projects_track_progress.png) + +
+💬 Create a personal project on GitHub + +On your profile, select the `Projects` tab : +![Image](https://github.com/lowlighter/metrics/blob/master/.github/readme/imgs/plugin_projects_create.png) + +Fill the informations and set visibility to *public* : +![Image](https://github.com/lowlighter/metrics/blob/master/.github/readme/imgs/plugin_projects_setup.png) + +
+ +
+ ### ⏭️ 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.