Skip to content

Commit

Permalink
feat: updated readme with added action permission and preps for next …
Browse files Browse the repository at this point in the history
…release
  • Loading branch information
akhilmhdh committed May 3, 2024
1 parent d560e9d commit 37ed032
Showing 1 changed file with 8 additions and 3 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,9 +40,12 @@ jobs:
contrib-readme-job:
runs-on: ubuntu-latest
name: A job to automate contrib in readme
permissions:
contents: write
pull-requests: write
steps:
- name: Contribute List
uses: akhilmhdh/contributors-readme-action@v2.3.9
uses: akhilmhdh/contributors-readme-action@v2.3.10
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Expand All @@ -52,7 +55,8 @@ That's it!
To add it to your existing workflow, **append** this to your current `.yml` workflow script.

```yml
- uses: akhilmhdh/contributors-readme-action@v2.3.9
# add required write permission
- uses: akhilmhdh/contributors-readme-action@v2.3.10
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Expand Down Expand Up @@ -133,7 +137,8 @@ You can add these optional parameters in your action script to modify the appear

```yml
- name: Contribute List
uses: akhilmhdh/contributors-readme-action@v2.3.9
# add required write permission
uses: akhilmhdh/contributors-readme-action@v2.3.10
with:
image_size: 100
```
Expand Down

0 comments on commit 37ed032

Please sign in to comment.