Skip to content

Commit

Permalink
docs: upate README
Browse files Browse the repository at this point in the history
  • Loading branch information
piquark6046 committed Dec 7, 2024
1 parent b652a75 commit 766d5f6
Showing 1 changed file with 4 additions and 31 deletions.
35 changes: 4 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,8 @@
## jsDelivr-Purge

This GitHub actions is automatic jsDelivr purging process for GitHub public repositories.
This GitHub actions is automatic jsDelivr purging process for npm public package.

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

```yaml
name: 'Run jsDelivr-Purge'

jobs:
jsdelivrpurge:
permissions:
actions: read
contents: read
runs-on: ubuntu-latest
steps:
- name: Set up NodeJS LTS
uses: actions/setup-node@v4
with:
node-version: 'lts/*'
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Run jsDelivr-Purge
uses: List-KR/[email protected]
```
The jsDelivr-Purge supports `workflow_dispatch`, `schedule` and `push` event.

It always purges `latest` and the default branch of your repo.

> [!WARNING]
> jsDelivr will add authentication data into a request header.
> You need to pay attention to this change!
`package` : A npm package that will be purged
`disttag` : List of the `dist-tag` property of the npm packages. Separated by a space.

0 comments on commit 766d5f6

Please sign in to comment.