Skip to content

Commit 7a2323c

Browse files
chore: update README with license and release badge
1 parent 08e9d45 commit 7a2323c

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

README.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation Github Pages Action
22

3-
3+
![Release](https://github.com/smartoperatingblock/documentation-ghp-action/actions/workflows/release.yml/badge.svg?style=plastic)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=plastic)](https://opensource.org/licenses/MIT)
55
![Version](https://img.shields.io/github/v/release/smartoperatingblock/documentation-ghp-action?style=plastic)
66

@@ -21,10 +21,10 @@ For every selected type specify the command, input file and destination folder o
2121
- `asyncapi-documentation-input-file` default *'docs/asyncapi/asyncapi.yml'*
2222
- `asyncapi-documentation-dst-folder` default *''documentation/asyncapi-doc/'*
2323

24-
Finally, provide the GITHUB_TOKEN to allow the action to push on *gh-pages* branch:
24+
Finally, provide the *GITHUB_TOKEN* to allow the action to push on *gh-pages* branch:
2525
- `github-token`
2626

27-
## Example
27+
## Usage
2828

2929
An example of how to use the action with all types of documentations and inputs:
3030
```yaml
@@ -48,3 +48,6 @@ jobs:
4848
asyncapi-documentation-dst-folder: 'documentation/asyncapi-doc'
4949
github-token: ${{ secrets.GITHUB_TOKEN }}
5050
```
51+
## License
52+
53+
The action is released under the [MIT](https://opensource.org/licenses/MIT) License.

0 commit comments

Comments
 (0)