Skip to content

Commit

Permalink
chore: update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
bobz25 authored Oct 25, 2022
2 parents a3bc11e + 0db825c commit d22d90c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,20 @@ Github action for update description on repository.

## Usage

- [Example](./.github/workflows/main.yml)

```yaml
uses: zhengbangbo/[email protected]
with:
repo: ${{ github.repository }}
repo-token: ${{ secrets.MY_TOKEN }}
```
> **Note**
> 1. Creat [PAT(Personal access token)](https://github.com/settings/tokens) and set `actions secrets` of repository.
> 2. If `repo-token` use `secrets.GITHUB_TOKEN` or `github.token`, throw `Error: Resource not accessible by integration`. Like [this job](https://github.com/zhengbangbo/update-repository-description/actions/runs/3318862036/jobs/5483297578).


## License

MIT

0 comments on commit d22d90c

Please sign in to comment.