Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
40 changes: 35 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

**Website:** https://hotspots.dev  |  **Docs:** https://docs.hotspots.dev  |  **Crates.io:** [![crates.io](https://img.shields.io/crates/v/hotspots-cli.svg)](https://crates.io/crates/hotspots-cli)

**Install:** `cargo install hotspots-cli`  |  `curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh`
**Install:** `brew install Stephen-Collins-tech/tap/hotspots`  |  `npm install -g @stephencollinstech/hotspots`  |  `pip install hotspots-cli`  |  `cargo install hotspots-cli`

**Find the code that's actually causing problems.**

Expand Down Expand Up @@ -147,17 +147,32 @@ hotspots analyze . --mode delta --all-functions --format json

### 1. Install

**macOS (Homebrew):**
```bash
brew install Stephen-Collins-tech/tap/hotspots
```

**npm:**
```bash
npm install -g @stephencollinstech/hotspots
```

**pip:**
```bash
pip install hotspots-cli
```

**cargo (Rust toolchain):**
```bash
cargo install hotspots-cli
```

**macOS / Linux:**
**macOS / Linux (shell script):**
```bash
curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh
```

Installs to `~/.local/bin/hotspots`. Verify with `hotspots --version`.
Verify with `hotspots --version`.

**GitHub Action:**
```yaml
Expand Down Expand Up @@ -566,17 +581,32 @@ Outputs ready-to-use shell hooks and pre-commit framework config for enforcing p

### Quick Install

**macOS (Homebrew):**
```bash
brew install Stephen-Collins-tech/tap/hotspots
```

**npm:**
```bash
npm install -g @stephencollinstech/hotspots
```

**pip:**
```bash
pip install hotspots-cli
```

**cargo (Rust toolchain):**
```bash
cargo install hotspots-cli
```

**macOS / Linux:**
**macOS / Linux (shell script):**
```bash
curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh
```

Installs to `~/.local/bin/hotspots`. Verify with `hotspots --version`.
Verify with `hotspots --version`.

**Install a specific version:**
```bash
Expand Down
26 changes: 26 additions & 0 deletions docs/getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@
brew install Stephen-Collins-tech/tap/hotspots
```

### npm

```bash
npm install -g @stephencollinstech/hotspots
```

Works on macOS, Linux, and Windows. No Rust toolchain required.

### pip

```bash
pip install hotspots-cli
```

Available on [PyPI](https://pypi.org/project/hotspots-cli/). Works on macOS, Linux, and Windows.

### Linux

```bash
Expand Down Expand Up @@ -75,6 +91,16 @@ hotspots analyze --help
brew upgrade Stephen-Collins-tech/tap/hotspots
```

**npm:**
```bash
npm update -g @stephencollinstech/hotspots
```

**pip:**
```bash
pip install --upgrade hotspots-cli
```

**Linux:**
```bash
curl -fsSL https://raw.githubusercontent.com/Stephen-Collins-tech/hotspots/main/install.sh | sh
Expand Down
Loading