Skip to content

Update README for latest installation instructions with automated publishing#11

Merged
Yukaii merged 3 commits intomainfrom
copilot/fix-10
Jun 5, 2025
Merged

Update README for latest installation instructions with automated publishing#11
Yukaii merged 3 commits intomainfrom
copilot/fix-10

Conversation

Copy link
Contributor

Copilot AI commented Jun 5, 2025

Updated the README to reflect the current automated npm publishing setup and ensure all installation instructions are accurate and up-to-date.

Changes Made

📦 Installation Section

  • Added separate sections for stable and beta releases
  • Documented the automated GitHub Actions publishing system
  • Added note explaining when stable vs beta releases are published

🛠️ CLI Examples

  • Updated command examples with helpful comments
  • Added the region command to the examples (useful for seeing available regions)
  • Verified all example commands work correctly
  • Improved the ordering of commands for better user flow

🔧 Development Instructions

  • Updated development setup to include correct directory navigation
  • Added missing cd tailportal step after cloning
  • Specified that commands should be run from packages/tailportal directory
  • Updated example commands to match current CLI implementation

✅ Verification

  • All existing e2e tests continue to pass
  • Created comprehensive tests to verify README accuracy
  • Confirmed all documented commands work as expected
  • Validated that example regions (like ewr) are valid

The README now accurately reflects:

  • Both stable (npm install -g tailportal) and beta (npm install -g tailportal@beta) installation options
  • The automated publishing workflow via GitHub Actions
  • Current CLI commands and their proper usage
  • Correct development setup procedures

Fixes #10.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits June 5, 2025 12:50
Co-authored-by: Yukaii <4230968+Yukaii@users.noreply.github.com>
Co-authored-by: Yukaii <4230968+Yukaii@users.noreply.github.com>
Copilot AI changed the title [WIP] Update README for latest installation instruction Update README for latest installation instructions with automated publishing Jun 5, 2025
Copilot AI requested a review from Yukaii June 5, 2025 12:54
Copilot finished work on behalf of Yukaii June 5, 2025 12:54
@Yukaii Yukaii marked this pull request as ready for review June 5, 2025 12:57
@Yukaii Yukaii merged commit dacbf67 into main Jun 5, 2025
2 checks passed
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.

Update README for latest installation instruction

2 participants