From 13e1fd14847babf18705f192dec8e5126357e94f Mon Sep 17 00:00:00 2001 From: Simone Corsi Date: Sat, 16 Jan 2021 09:09:13 +0100 Subject: [PATCH 1/2] fix: variable name --- src/api.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/api.ts b/src/api.ts index 61d663c..1bdee33 100644 --- a/src/api.ts +++ b/src/api.ts @@ -1,7 +1,7 @@ import got from 'got'; import core from '@actions/core'; -const GITHUB_TOKEN = core.getInput('githubToken', { required: true }); +const GITHUB_TOKEN = core.getInput('github-token', { required: true }); export default got.extend({ headers: { From e1c9ca0a6f1923d8d1fc897abad47694e7c31dd8 Mon Sep 17 00:00:00 2001 From: Simone Corsi Date: Sat, 16 Jan 2021 09:09:24 +0100 Subject: [PATCH 2/2] docs: added readme --- README.md | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 22ccbed..ef85a35 100644 --- a/README.md +++ b/README.md @@ -1 +1,21 @@ -# mawesome \ No newline at end of file +# 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 is `required` + +## Outputs + +Output the generated list in the project `README.md` + +## Example usage + +```yml + uses: simonecorsi/mawesome@v1 + with: + github-token: ${{ secrets.GITHUB_TOKEN }} +```