Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
dalance committed Mar 10, 2024
1 parent 017251f commit 2379326
Showing 1 changed file with 20 additions and 2 deletions.
22 changes: 20 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ This action downloads a prebuilt [Veryl](https://veryl-lang.org/) binary and add
By default, this action downloads the latest version of Veryl.

```yaml
name: My workflow
name: Check
on: [push, pull_request]
jobs:
test:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -28,6 +28,24 @@ Version specification through `version` can be used.
version: 0.7.2
```

### Publish documents through GitHub Pages

```yaml
name: Deploy
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: veryl-lang/setup-veryl@v1
- run: veryl doc
- uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: doc
```

## License

Licensed under either of
Expand Down

0 comments on commit 2379326

Please sign in to comment.