Skip to content

Commit

Permalink
Merge pull request #7 from miketrebilcock/docs
Browse files Browse the repository at this point in the history
Update usage example
  • Loading branch information
miketrebilcock authored Sep 6, 2024
2 parents 0d9e277 + 3af2499 commit f8f7434
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,30 @@ permissions:
| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | -------------- |
| `gh-token` | `GITHUB_TOKEN` (permissions `contents: read` and `pull-requests: write`) or a `repo` scoped [Personal Access Token (PAT)](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token). | no | `GITHUB_TOKEN` |

### Workflow

Add the following GitHub workflow to your repository.

```yaml
name: Insert Class Diagram
on:
pull_request:
branches:
- main
permissions:
contents: read
pull-requests: write
jobs:
createClassDiagram:
name: Create Diagram
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: miketrebilcock/python-code-visualiser@v1
with:
gh-token: ${{ secrets.gh_token }}
```

## Outputs

## Contributing
Expand Down

0 comments on commit f8f7434

Please sign in to comment.