docs: clarify program behavior
This commit is contained in:
@@ -2,11 +2,12 @@
|
|||||||
|
|
||||||
**shy-launcher** is an utility for downloading assets and launching applications on Linux.
|
**shy-launcher** is an utility for downloading assets and launching applications on Linux.
|
||||||
|
|
||||||
## What can it do?
|
## What does it do?
|
||||||
It can:
|
|
||||||
- Download assets over HTTP/S before the program starts
|
- Download latest version of defined assets over HTTP/S
|
||||||
- Verify that you have the latest version of your files/program/plugins
|
|
||||||
- Change permissions for executable downloads
|
- Change permissions for executable downloads
|
||||||
|
- Execute the command provided in the config
|
||||||
|
- Wait until the program exits
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
@@ -19,7 +20,7 @@ Below is an example `config.json`; adapt it to your needs:
|
|||||||
"args": ["-jar", "server.jar"],
|
"args": ["-jar", "server.jar"],
|
||||||
"downloads": [{
|
"downloads": [{
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
"url": "https://some.asset.server.shiewk.de/coolserver/latest/server.jar",
|
"url": "https://some.asset.server/coolserver/latest/server.jar",
|
||||||
"headers": {
|
"headers": {
|
||||||
"Authorization": "Bearer tOk3n"
|
"Authorization": "Bearer tOk3n"
|
||||||
},
|
},
|
||||||
|
|||||||
Reference in New Issue
Block a user