Merge pull request 'Update README.md' (#26) from natct/forgejo-release:update_readme into main

Reviewed-on: https://code.forgejo.org/actions/forgejo-release/pulls/26
Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org>

README.md

@@ -13,25 +13,27 @@ Upload or download the assets of a release to a Forgejo instance.
 | `url` | <p>URL of the Forgejo instance</p> | `false` | `""` |
 | `repo` | <p>owner/project relative to the URL</p> | `false` | `""` |
 | `tag` | <p>Tag of the release</p> | `false` | `""` |
-| `title` | <p>Title of the release</p> | `false` | `""` |
+| `title` | <p>Title of the release (defaults to tag)</p> | `false` | `""` |
 | `sha` | <p>SHA of the release</p> | `false` | `""` |
 | `token` | <p>Forgejo application token</p> | `true` | `""` |
 | `release-dir` | <p>Directory in whichs release assets are uploaded or downloaded</p> | `true` | `""` |
 | `release-notes` | <p>Release notes</p> | `false` | `""` |
-| `direction` | <p>Can either be download or upload</p> | `true` | `""` |
+| `direction` | <p>Can either be <code>download</code> or <code>upload</code></p> | `true` | `""` |
 | `gpg-private-key` | <p>GPG Private Key to sign the release artifacts</p> | `false` | `""` |
 | `gpg-passphrase` | <p>Passphrase of the GPG Private Key</p> | `false` | `""` |
 | `download-retry` | <p>Number of times to retry if the release is not ready (default 1)</p> | `false` | `""` |
 | `download-latest` | <p>Download the latest release</p> | `false` | `false` |
 | `verbose` | <p>Increase the verbosity level</p> | `false` | `false` |
-| `override` | <p>Override an existing release by the same {tag}</p> | `false` | `false` |
+| `override` | <p>Override an existing release by the same <code>{tag}</code></p> | `false` | `false` |
 | `prerelease` | <p>Mark Release as Pre-Release</p> | `false` | `false` |
 <!-- action-docs-inputs source="action.yml" -->
 
-## Example
+## Examples
 
 ### Upload
 
+Upload the release located in `release-dir` to the release section of a repository (`url` and `repo`):
+
 ```yaml
 on: [tag]
 jobs:
@@ -39,7 +41,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/forgejo-release@v1
+      - uses: actions/forgejo-release@v2
         with:
           direction: upload
           url: https://code.forgejo.org
@@ -58,7 +60,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - uses: actions/forgejo-release@v1
+      - uses: actions/forgejo-release@v2
         with:
           direction: download
           url: https://code.forgejo.org
@@ -67,6 +69,15 @@ jobs:
           release-dir: ./  # by default, files are downloaded into dist/release
 ```
 
-## Update the README
+### Real world example
 
-With https://github.com/npalm/action-docs `action-docs --update-readme`
+This action is used to [publish](https://code.forgejo.org/forgejo/release-notes-assistant/src/branch/main/.forgejo/workflows/release.yml) the release notes assistant assets.
+
+## Update the `input` section of the README
+
+Using [action-docs](https://github.com/npalm/action-docs):
+
+```shell
+# Edit the action.yml file and run:
+action-docs --update-readme
+```

action.yml

@@ -23,7 +23,7 @@ inputs:
   release-notes:
     description: 'Release notes'
   direction:
-    description: 'Can either be download or upload'
+    description: 'Can either be `download` or `upload`'
     required: true
   gpg-private-key:
     description: 'GPG Private Key to sign the release artifacts'
@@ -38,7 +38,7 @@ inputs:
     description: 'Increase the verbosity level'
     default: 'false'
   override:
-    description: 'Override an existing release by the same {tag}'
+    description: 'Override an existing release by the same `{tag}`'
     default: 'false'
   prerelease:
     description: 'Mark Release as Pre-Release'