Fix docs and help strings

Author: ArronaxKP

lib/defaults.go

@@ -28,7 +28,7 @@ const (
 	DefaultMirror             = "https://releases.hashicorp.com/terraform"
 	DefaultLatest             = ""
 	installFile               = "terraform"
-	installDir                = ".terraform.versions"
+	InstallDir                = ".terraform.versions"
 	recentFile                = "RECENT"
 	tfDarwinArm64StartVersion = "1.0.2"
 	VersionPrefix             = "terraform_"

lib/param_parsing/parameters.go

@@ -35,7 +35,7 @@ func GetParameters() Params {
 	getopt.StringVarLong(&params.CustomBinaryPath, "bin", 'b', "Custom binary path. Ex: tfswitch -b "+lib.ConvertExecutableExt("/Users/username/bin/terraform"))
 	getopt.StringVarLong(&params.DefaultVersion, "default", 'd', "Default to this version in case no other versions could be detected. Ex: tfswitch --default 1.2.4")
 	getopt.BoolVarLong(&params.HelpFlag, "help", 'h', "Displays help message")
-	getopt.StringVarLong(&params.InstallPath, "install", 'i', "Custom install path. Ex: tfswitch -b "+lib.ConvertExecutableExt("/Users/username"))
+	getopt.StringVarLong(&params.InstallPath, "install", 'i', "Custom install path. Ex: tfswitch -i /Users/username. The binaries will be in the sub installDir directory e.g. /Users/username/"+lib.InstallDir)
 	getopt.BoolVarLong(&params.LatestFlag, "latest", 'u', "Get latest stable version")
 	getopt.StringVarLong(&params.LatestPre, "latest-pre", 'p', "Latest pre-release implicit version. Ex: tfswitch --latest-pre 0.13 downloads 0.13.0-rc1 (latest)")
 	getopt.StringVarLong(&params.LatestStable, "latest-stable", 's', "Latest implicit version based on a constraint. Ex: tfswitch --latest-stable 0.13.0 downloads 0.13.7 and 0.13 downloads 0.15.5 (latest)")

www/docs/usage/commandline.md

@@ -23,8 +23,7 @@ The most recently selected versions are presented at the top of the dropdown.
 
 ## Use environment variables
 
-You can also set the `TF_VERSION` environment variable to your desired terraform version.
-For example:
+You can also set the `TF_VERSION` environment variable to your desired terraform version. For example:
 
 ```bash
 export TF_VERSION=0.14.4
@@ -77,7 +76,7 @@ tfswitch --mirror https://example.jfrog.io/artifactory/hashicorp`
 
 ## Install to non-default location
 
-By default `tfswitch` will download the Terraform binary to the user home directory under this path: `/Users/warrenveerasingam/.terraform.versions`
+By default `tfswitch` will download the Terraform binary to the user home directory under this path: `$HOME/.terraform.versions`
 
 If you want to install the binaries outside of the home directory then you can provide the `-i` or `--install` to install Terraform binaries to a non-standard path. Useful if you want to install versions of Terraform that can be shared with multiple users.
 

www/docs/usage/config-files.md

@@ -36,13 +36,13 @@ This is similiar to using a .tfswitchrc file, but you can specify a custom binar
 ![toml1](../static/tfswitch-v7.gif)
 ![toml2](../static/tfswitch-v8.gif)
 
-1. Create a custom binary path. Ex: `mkdir /Users/warrenveerasingam/bin` (replace warrenveerasingam with your username)
-2. Add the path to your PATH. Ex: `export PATH=$PATH:/Users/warrenveerasingam/bin` (add this to your bash profile or zsh profile)
-3. Pass -b or --bin parameter with your custom path to install terraform. Ex: `tfswitch -b /Users/warrenveerasingam/bin/terraform 0.10.8 `
+1. Create a custom binary path. Ex: `mkdir $HOME/bin` (replace warrenveerasingam with your username)
+2. Add the path to your PATH. Ex: `export PATH=$PATH:$HOME/bin` (add this to your bash profile or zsh profile)
+3. Pass -b or --bin parameter with your custom path to install terraform. Ex: `tfswitch -b $HOME/bin/terraform 0.10.8 `
 4. Optionally, you can create a `.tfswitch.toml` file in your terraform directory(current directory) OR in your home directory(~/.tfswitch.toml). The toml file in the current directory has a higher precedence than toml file in the home directory
 5. Your `.tfswitch.toml` file should look like this:
 ```ruby
-bin = "/Users/warrenveerasingam/bin/terraform"
+bin = "$HOME/bin/terraform"
 version = "0.11.3"
 ```
 4. Run `tfswitch` and it should automatically install the required terraform version in the specified binary path