Skip to content

chore: add postinstall script to support git installations #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2025
Merged

chore: add postinstall script to support git installations #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions INSTALL.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ bun add @coder/ghostty-web
yarn add @coder/ghostty-web
```

### Installing from Git

You can install directly from GitHub:

```bash
npm install github:coder/ghostty-web
# or
bun add github:coder/ghostty-web
```

**Note:** When installing from git, the package automatically builds itself via a `postinstall` script. This requires Bun to be installed and may take a few seconds during installation.

## Basic Usage

```typescript
Expand Down
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,14 @@ A web-based terminal emulator that integrates [Ghostty's](https://github.com/gho
npm install @coder/ghostty-web
```

Or install from GitHub:

```bash
npm install github:coder/ghostty-web
```

**Note:** Git installs will auto-build during `postinstall` (requires Bun).

## Quick Start

```typescript
Expand Down
3 changes: 2 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,8 @@
"fmt:fix": "prettier --write .",
"lint": "biome check .",
"lint:fix": "biome check --write .",
"prepublishOnly": "bun run test && bun run build"
"prepublishOnly": "bun run test && bun run build",
"postinstall": "[ -d dist ] || bun run build"
},
"devDependencies": {
"@biomejs/biome": "^1.9.4",
Expand Down