From 26c2d1acc3de9d9791dbe11d98020ee964490482 Mon Sep 17 00:00:00 2001 From: Bill Zimmerman Date: Sun, 1 Dec 2019 10:57:21 +0100 Subject: [PATCH] Updated Quick Installer usage (markdown) --- Quick-Installer-usage.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/Quick-Installer-usage.md b/Quick-Installer-usage.md index a3fc662..836e993 100644 --- a/Quick-Installer-usage.md +++ b/Quick-Installer-usage.md @@ -1,4 +1,4 @@ -The [Quick Installer](https://github.com/billz/raspap-webgui/blob/master/installers/raspbian.sh) has several options for configuring a RaspAP installation. You can retrieve usage notes by requesting the installer like so: +The [Quick Installer](https://github.com/billz/raspap-webgui/blob/master/installers/raspbian.sh) has several options for configuring a RaspAP installation. You can retrieve these usage notes from your command shell by requesting the installer like so: ``` curl -sL https://install.raspap.com | bash -s -- --help @@ -21,7 +21,13 @@ If you have forked this project to your own GitHub repo, this option lets you ov #### -b, --branch `` Similarly, this option overrides the default git branch (`master`). This is useful if you have created a feature branch (`my-feature`) and wish to perform an installation using the Quick Installer. An alternate branch name is a required parameter. -An example combining the two options is given below: +An example combining the `repo` and `branch` options is given below: ``` curl -sL https://install.raspap.com | bash -s -- --repo foo/bar --branch my-feature ``` + +#### -h, --help +Outputs these usage notes and exits. + +#### -v, --version +Outputs RaspAP release info and exits. \ No newline at end of file