Skip to content

Commit

Permalink
chore: update README.md to provide installation instruction
Browse files Browse the repository at this point in the history
  • Loading branch information
jianliang00 committed Nov 25, 2024
1 parent 341f1ea commit 6c3578d
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,15 @@ integration in CI environment.
It is also easy to use for developers. No need to execute many commands manually, just run `./hab sync .` to set up
local development environment.

## Installation

We provide both a binary (hab.pex) and a wrapper script. You can find them in the releases and choose to download one of them as your need.

The simplest way is to download the wrapper using following instruction:
```shell
curl -L -O https://github.com/tiktok/habitat/releases/download/0.3.134/hab
```

## Usage

1. Generate habitat configuration file in the repo.
Expand Down

0 comments on commit 6c3578d

Please sign in to comment.