From af9dafa0865845e5d8f7870d21fd0591729b72a0 Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Wed, 5 Nov 2025 15:19:39 -0800 Subject: [PATCH 1/2] Update Readme.md to hyperlink to Github to resolve broken links on Pypi.org. --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 621e8f9..4ec5ec6 100644 --- a/README.md +++ b/README.md @@ -25,6 +25,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** @@ -34,18 +35,20 @@ Get the Workato CLI running in 5 minutes. ## Installation ### From PyPI (Coming Soon) + ```bash pip install workato-platform-cli ``` ### From Source + ```bash git clone https://github.com/workato-devs/workato-platform-cli.git cd workato-platform-cli make install ``` -Having issues? See [DEVELOPER_GUIDE.md](/docs/DEVELOPER_GUIDE.md) for troubleshooting. +Having issues? See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/blob/main/docs/DEVELOPER_GUIDE.md) for troubleshooting. ## Setup @@ -57,7 +60,6 @@ workato init workato workspace ``` - ## First Commands ```bash @@ -76,12 +78,11 @@ workato workspace ## Next Steps -- **Need detailed commands?** → See [COMMAND_REFERENCE.md](/docs/COMMAND_REFERENCE.md) -- **Want real-world examples?** → See [USE_CASES.md](/docs/USE_CASES.md) -- **Looking for sample recipes?** → See [examples/](/docs/examples/) -- **Installation issues?** → See [DEVELOPER_GUIDE.md](/docs/DEVELOPER_GUIDE.md) -- **Looking for all documentation?** → See [INDEX.md](/docs/INDEX.md) - +- **Need detailed commands?** → See [COMMAND_REFERENCE.md](https://github.com/workato-devs/blob/main/docs/COMMAND_REFERENCE.md) +- **Want real-world examples?** → See [USE_CASES.md](https://github.com/workato-devs/blob/main/docs/USE_CASES.md) +- **Looking for sample recipes?** → See [examples/](https://github.com/workato-devs/blob/main/docs/examples/) +- **Installation issues?** → See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/blob/main/docs/DEVELOPER_GUIDE.md) +- **Looking for all documentation?** → See [INDEX.md](https://github.com/workato-devs/blob/main/docs/INDEX.md) ## Quick Recipe Workflow @@ -98,12 +99,12 @@ workato pull You're ready to go! - ## Contributing to the CLI These commands are for CLI maintainers and contributors, not for developers using the CLI to build Workato integrations. ### For Development + ```bash # Setup (with uv - recommended) make install-dev @@ -119,8 +120,8 @@ make lint # check code quality make build # build distribution packages ``` - ### Tech Stack + - **🐍 Python 3.11+** with full type annotations - **⚡ uv** for fast dependency management - **🔍 mypy** for static type checking From a89154ba11e03e8756e63d28971d1a143b191b4b Mon Sep 17 00:00:00 2001 From: Chris Miller Date: Thu, 6 Nov 2025 12:56:14 -0800 Subject: [PATCH 2/2] Correct typo in hyperlinks in Readme.md --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4ec5ec6..ccf08bc 100644 --- a/README.md +++ b/README.md @@ -48,7 +48,7 @@ cd workato-platform-cli make install ``` -Having issues? See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/blob/main/docs/DEVELOPER_GUIDE.md) for troubleshooting. +Having issues? See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md) for troubleshooting. ## Setup @@ -78,11 +78,11 @@ workato workspace ## Next Steps -- **Need detailed commands?** → See [COMMAND_REFERENCE.md](https://github.com/workato-devs/blob/main/docs/COMMAND_REFERENCE.md) -- **Want real-world examples?** → See [USE_CASES.md](https://github.com/workato-devs/blob/main/docs/USE_CASES.md) -- **Looking for sample recipes?** → See [examples/](https://github.com/workato-devs/blob/main/docs/examples/) -- **Installation issues?** → See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/blob/main/docs/DEVELOPER_GUIDE.md) -- **Looking for all documentation?** → See [INDEX.md](https://github.com/workato-devs/blob/main/docs/INDEX.md) +- **Need detailed commands?** → See [COMMAND_REFERENCE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/COMMAND_REFERENCE.md) +- **Want real-world examples?** → See [USE_CASES.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/USE_CASES.md) +- **Looking for sample recipes?** → See [examples/](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/examples/) +- **Installation issues?** → See [DEVELOPER_GUIDE.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/DEVELOPER_GUIDE.md) +- **Looking for all documentation?** → See [INDEX.md](https://github.com/workato-devs/workato-platform-cli/blob/main/docs/INDEX.md) ## Quick Recipe Workflow