Skip to content

Commit df01330

Browse files
docs: add manual installation instructions while npm is unavailable
Added Option 1 (clone locally) and Option 2 (GitHub install) since npm authentication is currently broken. NPM install will be available once we can complete the publish.
1 parent 9b5fdea commit df01330

1 file changed

Lines changed: 15 additions & 7 deletions

File tree

README.md

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,29 @@ Interactive TUI for installing curated GitHub Actions workflows with a cyberpunk
1313

1414
## Installation
1515

16+
### Option 1: Clone and run locally (recommended for now)
17+
1618
```bash
19+
git clone https://github.com/openstaticfish/actionflow.git
20+
cd actionflow
1721
bun install
22+
bun run src/tui/index.tsx
1823
```
1924

20-
## Usage
21-
22-
Launch the TUI:
25+
### Option 2: Install from GitHub
2326

2427
```bash
25-
bun run src/tui/index.tsx
26-
# or
27-
./src/tui/index.tsx
28+
# Install directly from GitHub
29+
bun install github:openstaticfish/actionflow
30+
31+
# Or clone and link globally
32+
git clone https://github.com/openstaticfish/actionflow.git
33+
cd actionflow
34+
bun link
35+
actionflow # Now available globally
2836
```
2937

30-
Or install globally:
38+
### Option 3: NPM (coming soon)
3139

3240
```bash
3341
bun install -g @openstaticfish/actionflow

0 commit comments

Comments
 (0)