Skip to content

Commit

Permalink
Merge pull request #42 from snow-actions/readme
Browse files Browse the repository at this point in the history
Update readme
  • Loading branch information
SnowCait authored Dec 28, 2024
2 parents c9ba5a5 + 17855a1 commit 54162fd
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# QR Code Generator

![units-test](https://github.com/snow-actions/qrcode/workflows/units-test/badge.svg)
[![Test](https://github.com/snow-actions/qrcode/actions/workflows/test.yml/badge.svg)](https://github.com/snow-actions/qrcode/actions/workflows/test.yml)

This action generates a QR Code file.
You can use the generated QR Code anywhere - upload to slack, commit to git, etc.
Expand All @@ -14,7 +14,7 @@ with:
path: 'qrcode.png'
```
## Examples
## Example
```yaml
name: QRCode
Expand All @@ -27,17 +27,16 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v4
with:
ref: qrcode
- uses: snow-actions/[email protected]
with:
text: https://github.com/snow-actions/qrcode
path: qrcode.png
- uses: snow-actions/[email protected]
- name: You can commit it.
run: |
git config --global user.email "[email protected]"
git config --global user.name "Your Name"
git add qrcode.png
git commit -m "QR Code"
git push origin qrcode
Expand Down

0 comments on commit 54162fd

Please sign in to comment.