Add documentation
This commit is contained in:
parent
3ec7e74bf8
commit
5cfda63817
18
README.md
18
README.md
@ -1,3 +1,21 @@
|
|||||||
# Lgoad upload action
|
# Lgoad upload action
|
||||||
|
|
||||||
This is a Gitea/Github action to automatically upload a file to lgoad
|
This is a Gitea/Github action to automatically upload a file to lgoad
|
||||||
|
|
||||||
|
## Inputs
|
||||||
|
|
||||||
|
| name | description | required | default |
|
||||||
|
| ---- | ----------- | -------- | ------- |
|
||||||
|
| `file` | Path to the file to upload | ✅ | N/A |
|
||||||
|
| `token` | lgoad token to use | ✅ | N/A |
|
||||||
|
| `content-type` | Content-type of the file | ❌ | Derived from the file path |
|
||||||
|
| `custom-name` | Custom name to give to the file | ❌ | Same as the file name |
|
||||||
|
| `custom-machine-name` | Custom machine name to put in the path | ❌ | Hostname of the runner |
|
||||||
|
| `use-salt` | If `true`, a random salt is appended at the end of the file name | ❌ | `false` |
|
||||||
|
|
||||||
|
## Outputs
|
||||||
|
|
||||||
|
| name | description | example |
|
||||||
|
| ---- | ----------- | ------- |
|
||||||
|
| `url` | A url to the uploaded file | `https://free.estrogen.download/kodi/machine/filename.txt` |
|
||||||
|
| `uri` | The uri of the uploaded file, usable with all lgoad domains | `kodi/machine/filename.txt` |
|
||||||
|
Loading…
Reference in New Issue
Block a user