Update README

This commit is contained in:
CrazyMax 2020-05-03 21:52:25 +02:00
parent 297fd4647b
commit b4d10f8af7
No known key found for this signature in database
GPG key ID: 3248E46B6BB8C7F7
3 changed files with 14 additions and 2 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

View file

@ -1,5 +1,5 @@
# Changelog
## 1.0.0 (2019/09/22)
## 0.1.0 (2020/05/03)
* Initial version

View file

@ -10,6 +10,8 @@ GitHub Action to easily import your GPG key to sign commits and tags.
If you are interested, [check out](https://git.io/Je09Y) my other :octocat: GitHub Actions!
![Import GPG key](.res/ghaction-import-gpg.png)
## Usage
```yaml
@ -28,11 +30,21 @@ jobs:
uses: actions/checkout@v2
-
name: Import GPG key
uses: crazy-max/ghaction-import-gpg@master
uses: crazy-max/ghaction-import-gpg@v1
env:
SIGNING_KEY: ${{ secrets.SIGNING_KEY }}
```
## Customizing
### environment variables
Following environment variables can be used as `step.env` keys
| Name | Description |
|----------------|---------------------------------------|
| `SIGNING_KEY` | GPG private key exported as an ASCII armored version |
## How can I help?
All kinds of contributions are welcome :raised_hands:! The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon: You can also support this project by [**becoming a sponsor on GitHub**](https://github.com/sponsors/crazy-max) :clap: or by making a [Paypal donation](https://www.paypal.me/crazyws) to ensure this journey continues indefinitely! :rocket: