Skip to content

Update README to be clear a checkout is required #170

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
benmccallum wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README to be clear a checkout is required #170

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
298a56e
Update README.md
benmccallum Mar 7, 2024
d0d1375
Merge branch 'master' into patch-1
benmccallum Apr 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 10 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,12 +56,15 @@ Returns an array of possible detected large file(s)
Consume the action by referencing the stable release

```yaml
uses: ppremk/lfs-warning@v3.2
with:
token: ${{ secrets.GITHUB_TOKEN }} # Optional
filesizelimit: 10MB
exclusionPatterns: |
**/*.png
- name: Checkout
uses: actions/checkout@v4

- uses: ppremk/lfs-warning@v3.2
with:
token: ${{ secrets.GITHUB_TOKEN }} # Optional
filesizelimit: 10MB
exclusionPatterns: |
**/*.png
```

## Contributers
Expand All @@ -75,4 +78,5 @@ with:
- [@srz-zumix](https://github.com/srz-zumix)
- [@zzgab](https://github.com/zzgab)
- [@samthebest](https://github.com/samthebest)
- [@benmccallum](https://github.com/benmccallum)