Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jackton1 committed Jan 3, 2022
1 parent da44773 commit dfc8660
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,20 +33,11 @@ Generate documentation from actions.yml like [this](#inputs) by simply adding `I
## Usage

```yaml
name: Update README.md using the actions.yml

on:
push:
branches:
- main

jobs:
update-doc:
runs-on: ubuntu-latest
...
steps:
- uses: actions/checkout@v2
- name: Run auto-doc
uses: tj-actions/auto-doc@v1.2.0
uses: tj-actions/auto-doc@v1.2.6
```

## Inputs
Expand Down Expand Up @@ -86,7 +77,7 @@ jobs:
fetch-depth: 0 # otherwise, you will failed to push refs to dest repo

- name: Run auto-doc
uses: tj-actions/auto-doc@v1.2.0
uses: tj-actions/auto-doc@v1.2.6

- name: Verify Changed files
uses: tj-actions/verify-changed-files@v8.6
Expand Down

0 comments on commit dfc8660

Please sign in to comment.