diff --git a/README.md b/README.md index 8e70735..55678c5 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ -# +# purge-jsdelivr-for-directory -## Project function +## Action function + +Refresh the cache of jsdelivr for a folder in the current repository + +## Usage + +### Example + +```yaml +name: refresh jsdelivr +run-name: 'refresh jsdelivr' +on: + push: + workflow_dispatch: + +jobs: + refresh-jsdelivr: + runs-on: ubuntu-latest + steps: + - name: Purge jsDelivr cache + uses: bling-yshs/purge-jsdelivr-for-directory@v1.0 + with: + path: | + rules +``` + +### Example repository + +[custom-clash-rule](https://github.com/bling-yshs/custom-clash-rule)