From 2148b560a756e306be7dac1f61ad5a163dc0dfd0 Mon Sep 17 00:00:00 2001
From: Chris Miller <chris.miller@workato.com>
Date: Tue, 4 Nov 2025 16:46:18 -0800
Subject: [PATCH] docs: update QUICK_START.md and remove _version.py from
 tracking

---
 .gitignore                           |  2 +-
 docs/QUICK_START.md                  | 36 +++++++++++++++++++++-------
 src/workato_platform_cli/_version.py | 34 --------------------------
 3 files changed, 28 insertions(+), 44 deletions(-)
 delete mode 100644 src/workato_platform_cli/_version.py

diff --git a/.gitignore b/.gitignore
index ed1be1f..1e0417f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -73,4 +73,4 @@ target/
 .ruff_cache
 
 
-src/workato_platform/_version.py
+src/workato_platform_cli/_version.py
diff --git a/docs/QUICK_START.md b/docs/QUICK_START.md
index 7af2f6f..994b4db 100644
--- a/docs/QUICK_START.md
+++ b/docs/QUICK_START.md
@@ -8,6 +8,7 @@ Get the Workato CLI running in 5 minutes.
 - Workato account with API token
 
 ### Getting Your API Token
+
 1. Log into your Workato account
 1. Navigate to **Workspace Admin** → **API clients**
 1. Click **Create API client**
@@ -16,20 +17,38 @@ Get the Workato CLI running in 5 minutes.
 
 ## Installation
 
-### Standard Installation
+There are multiple methods of installing Python packages, depending on how your local environment is setup. Below we cover a few possible methods based on common configurations.
+
+### Standard Installation - Try this first (Mac/Windows/Linux)
+
 ```bash
-pip install -e .
+python3 --version # Ensure your Python version is >= 3.11
+pip install workato-platform-cli
 workato --version  # Verify installation
 ```
 
-### Alternative (if standard fails)
-If you get an "externally-managed-environment" error:
+### Homebrew (Mac)
+
+Workato-platform-cli is not available in Homebrew yet. If your Python versions are managed in Homebrew, use the following method.
 
 ```bash
-# Virtual environment (recommended)
-python3 -m venv venv
-source venv/bin/activate  # Linux/Mac
-pip install -e .
+python3 --version # Ensure your Python version is >= 3.11
+brew install pipx
+pipx install workato-platform-cli
+workato --version  # Verify installation
+```
+
+### Alternative Installation
+
+Workato recommends using [UV](https://docs.astral.sh/uv/) to install and manage alternative versions of Python.
+
+Install UV [Other Install Options](https://docs.astral.sh/uv/getting-started/installation/)
+
+```bash
+curl -LsSf https://astral.sh/uv/install.sh | sh
+uv python install
+uv pip install workato-platform-cli
+workato --version  # Verify installation
 ```
 
 Having issues? See [DEVELOPER_GUIDE.md](DEVELOPER_GUIDE.md) for troubleshooting.
@@ -44,7 +63,6 @@ workato init
 workato workspace
 ```
 
-
 ## First Commands
 
 ```bash
diff --git a/src/workato_platform_cli/_version.py b/src/workato_platform_cli/_version.py
deleted file mode 100644
index 4fe9451..0000000
--- a/src/workato_platform_cli/_version.py
+++ /dev/null
@@ -1,34 +0,0 @@
-# file generated by setuptools-scm
-# don't change, don't track in version control
-
-__all__ = [
-    "__version__",
-    "__version_tuple__",
-    "version",
-    "version_tuple",
-    "__commit_id__",
-    "commit_id",
-]
-
-TYPE_CHECKING = False
-if TYPE_CHECKING:
-    from typing import Tuple
-    from typing import Union
-
-    VERSION_TUPLE = Tuple[Union[int, str], ...]
-    COMMIT_ID = Union[str, None]
-else:
-    VERSION_TUPLE = object
-    COMMIT_ID = object
-
-version: str
-__version__: str
-__version_tuple__: VERSION_TUPLE
-version_tuple: VERSION_TUPLE
-commit_id: COMMIT_ID
-__commit_id__: COMMIT_ID
-
-__version__ = version = '1.0.0rc4.dev9'
-__version_tuple__ = version_tuple = (1, 0, 0, 'rc4', 'dev9')
-
-__commit_id__ = commit_id = None