diff --git a/README.md b/README.md index 8cc82f7..324f3ab 100644 --- a/README.md +++ b/README.md @@ -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.** @@ -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 @@ -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 diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index 95cca5b..6b03212 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -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 @@ -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