Update README.md
This commit is contained in:
parent
2899af9b75
commit
3ccb07cca2
1 changed files with 4 additions and 6 deletions
10
README.md
10
README.md
|
@ -12,13 +12,11 @@ _**Note**: This action is supported on **all runners** operating systems (`ubunt
|
||||||
|
|
||||||
## 📚 Usage
|
## 📚 Usage
|
||||||
|
|
||||||
### Requirements
|
### ⚠️ Requirements
|
||||||
|
|
||||||
⚠️ The [`actions/checkout`](https://github.com/marketplace/actions/checkout) is mandatory to use this action, as it will be necessary to access the repository files.
|
- The [`actions/checkout`](https://github.com/marketplace/actions/checkout) is mandatory to use this action, as it will be necessary to access the repository files.
|
||||||
|
|
||||||
### ♻️ Scenarios
|
### `1️⃣ Minimal`: Commit and Push with `default` parameters
|
||||||
|
|
||||||
#### `1️⃣ Minimal`: Commit and Push with `default` parameters
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
|
@ -27,7 +25,7 @@ _**Note**: This action is supported on **all runners** operating systems (`ubunt
|
||||||
- uses: GuillaumeFalourd/git-commit-push@v1
|
- uses: GuillaumeFalourd/git-commit-push@v1
|
||||||
```
|
```
|
||||||
|
|
||||||
#### `2️⃣ Full`: Commit and Push with `customized` parameters
|
### `2️⃣ Full`: Commit and Push with `customized` parameters
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
steps:
|
steps:
|
||||||
|
|
Loading…
Add table
Reference in a new issue