From 0f8e9ce3784277d5fac756efe7733853d28d2522 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Wed, 6 Jul 2022 10:56:44 +0200 Subject: [PATCH] docs: updated readme --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index d403371..7670ee5 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,7 @@ You can see an example of the output at my own [simonecorsi/awesome](https://git - [Requirements](#requirements) - [Configuration](#configuration) - [`api-token`](#api-token) + - [`compact-by-topic`](#compact-by-topic) - [`template-path`](#template-path) - [Example workflow](#example-workflow) @@ -43,6 +44,10 @@ The Personal API Access Token is mandatory to fetch stars from the API without i You'll have to generate a [personal api token](https://github.com/settings/tokens/new) and then add +#### `compact-by-topic` + +If `compact-by-topic` is `'true'` it will generate another markdown file `TOPICS.md` whith all stars compacted by their github topics, be aware that this list will be bigger since data is duplicated. + #### `template-path` If you don't like the output (default example [here](./TEMPLATE.ejs) ), you can provide your custom template that will be rendered using [EJS](https://ejs.co/) template engine.