Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
edmocosta committed Jan 8, 2024
1 parent 0316458 commit accfea4
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,33 @@ brew tap edmocosta/homebrew-tap
brew install tuistash
```

### Manual
Download the latest release from the [GitHub releases page](https://github.com/edmocosta/tuistash/releases).
### Manual
Download the latest release from the [GitHub releases page](https://github.com/edmocosta/tuistash/releases) or build it from the source:

1 - Install Rust and Cargo (Linux and macOS):
```shell
curl https://sh.rustup.rs -sSf | sh
```

2 - Clone the repository:
```shell
git clone https://github.com/edmocosta/tuistash.git
```

3 - Build the binary (`target/release/tuistash`)
```shell
cd tuistash
```

```shell
cargo build --release
```

## Usage

**The Logstash's [monitoring API](https://www.elastic.co/guide/en/logstash/current/monitoring-logstash.html) must be enabled
and accessible from the client machine.**

```shell
$ ./tuistash --help
```
Expand Down

0 comments on commit accfea4

Please sign in to comment.