Skip to content

Commit

Permalink
docs: npm & homebrew installation (#349)
Browse files Browse the repository at this point in the history
  • Loading branch information
hougesen authored Sep 1, 2024
1 parent acfcca0 commit 78d2f7d
Show file tree
Hide file tree
Showing 3 changed files with 73 additions and 2 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).

#### [Unreleased](https://github.com/hougesen/hitt/compare/v0.0.12...HEAD)

- build(reqwest): switch to rustls instead of openssl [`#348`](https://github.com/hougesen/hitt/pull/348)
- build: publish to npm [`#347`](https://github.com/hougesen/hitt/pull/347)
- build(reqwest): enable brotli, deflate, gzip & json [`#346`](https://github.com/hougesen/hitt/pull/346)
- chore: bump dev version to v0.0.13 [`9f89839`](https://github.com/hougesen/hitt/commit/9f898398be39740711950536a566377544509f53)
Expand Down
34 changes: 34 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,20 @@ Options:

## Install

### Linux & MacOS

```shell
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/hougesen/hitt/releases/download/latest/hitt-installer.sh | sh
```

### Windows

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://github.com/hougesen/hitt/releases/download/latest/hitt-installer.ps1 | iex"
```

### Cargo

hitt can be installed using Cargo.

```shell
Expand All @@ -41,6 +55,26 @@ cargo install hitt --locked

If you do not have Cargo installed, you need to [install it first](https://www.rust-lang.org/learn/get-started).

### npm/npx

You can install hitt using npm:

```shell
npm install -g hitt
```

or run it directly using npx:

```shell
npx hitt run hello-world.http
```

### Homebrew

```shell
brew install hougesen/tap/hitt
```

## Usage

To send a request create a file ending in `.http`.
Expand Down
40 changes: 38 additions & 2 deletions docs/content/2.install.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,46 @@
title: Install
---

hitt can be installed using Cargo, the package manager for Rust.
## Install

### Linux & MacOS

```shell
cargo install hitt
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/hougesen/hitt/releases/download/latest/hitt-installer.sh | sh
```

### Windows

```powershell
powershell -ExecutionPolicy ByPass -c "irm https://github.com/hougesen/hitt/releases/download/latest/hitt-installer.ps1 | iex"
```

### Cargo

hitt can be installed using Cargo.

```shell
cargo install hitt --locked
```

If you do not have Cargo installed, you need to [install it first](https://www.rust-lang.org/learn/get-started).

### npm/npx

You can install hitt using npm:

```shell
npm install -g hitt
```

or run it directly using npx:

```shell
npx hitt run hello-world.http
```

### Homebrew

```shell
brew install hougesen/tap/hitt
```

0 comments on commit 78d2f7d

Please sign in to comment.