Skip to content

Update installation and development instructions - #78

Merged
jeri-temporal merged 1 commit into
mainfrom
jeri/readme
Jun 3, 2026
Merged

jeri-temporal merged 1 commit into
mainfrom
jeri/readme

Conversation

@jeri-temporal

@jeri-temporal jeri-temporal commented Jun 3, 2026 •

Copy link
Copy Markdown
Contributor

What was changed

  • Updated README.md to more closely match the style in the main CLI
  • Added more detailed installation instructions
  • Moved development instructions into CONTRIBUTING.md

Why?

Clearer instructions and improved consistency with the main CLI in preparation for making this repo public

Checklist

  1. Closes: N/A, quick update from slack

  2. How was this tested:
    Viewed the rendered markdown

  3. Any docs updates needed?
    This is documentation updates :)


Note

Low Risk
Markdown-only changes with no runtime or security impact; note the Windows PATH typo temoporal-cloud.exe in README.

Overview
Documentation is reorganized so README targets end users and CONTRIBUTING targets contributors, with README styling aligned to the main Temporal CLI.

README is retitled and reframed as the Temporal Cloud plugin. Installation is split into Homebrew, release download (with PATH steps), and a from-source build path using go build ./cmd/temporal-cloud. A short Usage section notes temporal cloud. Integration-test and API-key setup are removed from README.

CONTRIBUTING is new: make build, make test, integration tests via .env (TEMPORAL_API_KEY, default TEMPORAL_CLOUD_SERVER=saas-api.tmprl.cloud:443) and make test-integration, plus the commands.yml → make gen workflow for CLI commands.

Reviewed by Cursor Bugbot for commit 6b7e9ae. Bugbot is set up for automated code reviews on this repo. Configure here.

@jeri-temporal
jeri-temporal requested a review from a team as a code owner June 3, 2026 17:13
@jeri-temporal

Copy link
Copy Markdown
Contributor Author

bugbot run

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Bugbot reviewed your changes and found no new issues!

Comment @cursor review or bugbot run to trigger another review on this PR

Reviewed by Cursor Bugbot for commit 6b7e9ae. Configure here.

@anekkanti
anekkanti self-requested a review June 3, 2026 17:47
@jeri-temporal
jeri-temporal merged commit 410bbc3 into main Jun 3, 2026
6 checks passed
@jeri-temporal
jeri-temporal deleted the jeri/readme branch June 3, 2026 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants