feat: add README for configuration

Signed-off-by: Yasunori Fujie <fujie@ai2-jp.com>
yacchi · Aug 27, 2021 · 6b54489 · 6b54489
1 parent e1440bf
commit 6b54489
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -63,6 +63,13 @@ asdf go-sdk sync
 
 Check [asdf](https://github.com/asdf-vm/asdf) readme for more instructions on how to install & manage versions.
 
+# Configuration
+
+## Environment variables
+
+- GO_SDK_PATH - the directory where the Go SDK will be installed (default is $HOME/sdk)
+- GO_SDK_LOW_LIMIT_VERSION - the lower limit of the version displayed by list-all (default is 1.12.0)
+
 # Contributing
 
 Contributions of any kind welcome! See the [contributing guide](contributing.md).

diff --git a/lib/utils.bash b/lib/utils.bash
@@ -8,7 +8,7 @@ DOWNLOAD_URL="golang.org/dl"
 TOOL_NAME="go-sdk"
 TOOL_TEST="go version"
 GO_SDK_PATH=
-GO_LOW_LIMIT_VERSION="${GO_LOW_LIMIT_VERSION:-1.12.0}"
+GO_SDK_LOW_LIMIT_VERSION="${GO_SDK_LOW_LIMIT_VERSION:-1.12.0}"
 
 # shellcheck disable=SC1090
 source "${ASDF_DIR:-$HOME/.asdf}/lib/utils.bash"
@@ -51,7 +51,7 @@ go_plugin_tool() {
 }
 
 list_all_versions() {
-  go_plugin_tool sdk-versions "${GO_LOW_LIMIT_VERSION}"
+  go_plugin_tool sdk-versions "${GO_SDK_LOW_LIMIT_VERSION}"
 }
 
 go_sdk_path() {