actions/mawesome
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: updated readme

Browse Source
This commit is contained in:
GitHub Actions
2022-07-06 10:56:44 +02:00
parent aed446506b
commit 0f8e9ce378
1 changed files with 5 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
README.md
View File

@@ -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.