From f8a744a584a6026aea935b656b4052ba1d7b57db Mon Sep 17 00:00:00 2001 From: Pk11 Date: Sun, 1 Nov 2020 15:48:21 -0600 Subject: [PATCH] Updated downloadRelease (markdown) --- downloadRelease.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/downloadRelease.md b/downloadRelease.md index 70aefc9..ee2c06e 100644 --- a/downloadRelease.md +++ b/downloadRelease.md @@ -1,4 +1,4 @@ -The Function `downloadRelease` contains 4 Parameters, but it can have 5, if you like to include `prereleases` as well. +The `downloadRelease` function has 4 parameters, and 1 optional one. It downloads a file from a GitHub repository's releases. `repo` -> The Repository from which to download. @@ -6,17 +6,18 @@ The Function `downloadRelease` contains 4 Parameters, but it can have 5, if you `output` -> Where should the File be placed? -*optional* `includePrereleases` -> `true / false`! +*optional* `includePrereleases` -> `true / false`, defaults to false. `message` -> The Message which should be displayed while downloading. -You can find an example here: -``` - { - "type": "downloadRelease", - "repo": "Universal-Team/Universal-Updater", - "file": "Universal-Updater.cia", - "output": "sdmc:/Universal-Updater.cia", - "includePrereleases": false, - "message": "Downloading Universal-Updater.cia" - } \ No newline at end of file +Example: +```json +{ + "type": "downloadRelease", + "repo": "Universal-Team/Universal-Updater", + "file": "Universal-Updater.cia", + "output": "sdmc:/Universal-Updater.cia", + "includePrereleases": false, + "message": "Downloading Universal-Updater.cia" +} +``` \ No newline at end of file