Skip to content

Commit 766d5f6

Browse files
committed
docs: upate README
1 parent b652a75 commit 766d5f6

File tree

1 file changed

+4
-31
lines changed

1 file changed

+4
-31
lines changed

README.md

Lines changed: 4 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,8 @@
11
## jsDelivr-Purge
22

3-
This GitHub actions is automatic jsDelivr purging process for GitHub public repositories.
3+
This GitHub actions is automatic jsDelivr purging process for npm public package.
44

5-
If you want to purge jsDelivr cache automatically, please customize the following GitHub workflow file and add it:
5+
### Options
66

7-
```yaml
8-
name: 'Run jsDelivr-Purge'
9-
10-
jobs:
11-
jsdelivrpurge:
12-
permissions:
13-
actions: read
14-
contents: read
15-
runs-on: ubuntu-latest
16-
steps:
17-
- name: Set up NodeJS LTS
18-
uses: actions/setup-node@v4
19-
with:
20-
node-version: 'lts/*'
21-
- name: Checkout
22-
uses: actions/checkout@v4
23-
with:
24-
fetch-depth: 0
25-
- name: Run jsDelivr-Purge
26-
uses: List-KR/[email protected]
27-
```
28-
29-
The jsDelivr-Purge supports `workflow_dispatch`, `schedule` and `push` event.
30-
31-
It always purges `latest` and the default branch of your repo.
32-
33-
> [!WARNING]
34-
> jsDelivr will add authentication data into a request header.
35-
> You need to pay attention to this change!
7+
`package` : A npm package that will be purged
8+
`disttag` : List of the `dist-tag` property of the npm packages. Separated by a space.

0 commit comments

Comments
 (0)