mawesome/README.md
2021-01-16 11:09:35 +01:00

38 lines
766 B
Markdown

# mawesome
This action query the github api to get starred list of the user and then generates a list ordered by languages.
## Inputs
### `github-token`
The github workflow token
### `api-token`
Personal API Access Token to fetch stars from the API without incurring in Rate Limits.
You'll have to set this into the secrets yourself.
## Outputs
Output the generated list in the project `README.md`
## Example usage
```yml
name: Generate Awesome List
on: [workflow_dispatch]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Run a one-line script
uses: simonecorsi/mawesome@main
with:
api-token: ${{ secrets.API_TOKEN }}
github-token: ${{ secrets.GITHUB_TOKEN }}
```