Skip to content

Commit bd25905

Browse files
CopilotYukaii
andcommitted
Update README with automated publishing info and accurate CLI examples
Co-authored-by: Yukaii <4230968+Yukaii@users.noreply.github.com>
1 parent 00a3b67 commit bd25905

File tree

1 file changed

+24
-7
lines changed

1 file changed

+24
-7
lines changed

README.md

Lines changed: 24 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,24 @@ Bring your own key and pay your own bill, then let me do the rest.
66

77
## Installation
88

9-
Install tailportal globally with npm:
9+
### Stable Release
10+
11+
Install the latest stable version globally with npm:
1012

1113
```bash
1214
npm install -g tailportal
1315
```
1416

17+
### Beta Release
18+
19+
For the latest features and fixes, you can install the beta version which is automatically published from the main branch:
20+
21+
```bash
22+
npm install -g tailportal@beta
23+
```
24+
25+
> **Note**: Both stable and beta releases are automatically published via GitHub Actions. Stable releases are published when version tags are created, while beta releases are published on every push to the main branch.
26+
1527
## Usage
1628

1729
### Step 0: Install and setup pulumi CLI
@@ -65,21 +77,26 @@ Once installed globally and environment variables are set:
6577

6678
```bash
6779
tailportal --help
68-
tailportal list
69-
tailportal create vultr ewr
70-
tailportal remove instance-name
71-
tailportal destroy
80+
tailportal region # List available regions
81+
tailportal list # List current instances
82+
tailportal create vultr ewr # Create instance on Vultr in Newark
83+
tailportal remove instance-name # Remove specific instance
84+
tailportal destroy # Destroy the entire stack
7285
```
7386

7487
#### For development (from source):
7588

7689
```bash
7790
git clone https://github.com/Yukaii/tailportal
91+
cd tailportal
7892
pnpm install
7993

80-
pnpm start
94+
# From the tailportal package directory
95+
cd packages/tailportal
96+
pnpm start --help
97+
pnpm start region
8198
pnpm start list
82-
pnpm start create
99+
pnpm start create vultr ewr
83100
pnpm start remove instance-name
84101
pnpm start destroy
85102
```

0 commit comments

Comments
 (0)