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

docs: readme updated

Browse Source
This commit is contained in:
Simone Corsi
2021-01-16 12:27:42 +01:00
parent 380a0ec513
commit 192aa8add5
1 changed files with 15 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@@ -2,34 +2,38 @@
This action query the github api to get starred list of the user and then generates a list ordered by languages. This action query the github api to get starred list of the user and then generates a list ordered by languages.
## Setup
To use this action you have to create your own repository (eg: `yourname/awesome`), then create a new empty action in it and then use the [example workflow](#example-workflow) below as a starting point.
## Inputs ## Inputs
### `github-token` ### `github-token`
The github workflow token The github workflow token is mandatory
### `api-token` ### `api-token`
Personal API Access Token to fetch stars from the API without incurring in Rate Limits. The Personal API Access Token is mandatory to fetch stars from the API without incurring in Rate Limits.
You'll have to set this into the secrets yourself. You'll have to generate a [personal api token][https://github.com/settings/tokens/new] and then add
## Outputs ## Example workflow
Output the generated list in the project `README.md`
## Example usage
```yml ```yml
name: Generate Awesome List name: Update awesome list
on: [workflow_dispatch]
on:
workflow_dispatch:
schedule:
- cron: '0 0 * * *'
jobs: jobs:
build: build:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
- name: Run a one-line script - name: Awesome generator
uses: simonecorsi/mawesome@main uses: simonecorsi/mawesome@main
with: with:
api-token: ${{ secrets.API_TOKEN }} api-token: ${{ secrets.API_TOKEN }}