Skip to content

Add prerelease warning to README#24

Merged
jclusso merged 1 commit into
masterfrom
readme-prerelease-warning
Jun 1, 2026
Merged

Add prerelease warning to README#24
jclusso merged 1 commit into
masterfrom
readme-prerelease-warning

Conversation

@jclusso
Copy link
Copy Markdown
Member

@jclusso jclusso commented Jun 1, 2026

Adds a [!WARNING] callout to the README noting the CLI is prerelease software and not yet production ready, and that commands, flags, and output may change between releases.

Add a callout noting the CLI is prerelease software and not yet production ready, and that commands, flags, and output may change between releases.
Copilot AI review requested due to automatic review settings June 1, 2026 17:18
@jclusso jclusso merged commit 4763631 into master Jun 1, 2026
3 of 4 checks passed
@jclusso jclusso deleted the readme-prerelease-warning branch June 1, 2026 17:19
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds an explicit prerelease notice to the project README so users understand the CLI is not yet production-ready and that behavior may change across releases.

Changes:

  • Introduces a GitHub-flavored Markdown [!WARNING] callout near the top of the README.
  • Communicates prerelease status and potential breaking changes in commands/flags/output between releases.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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