Skip to content

Commit

Permalink
docs: updated README.md with download instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
c-x committed Jun 27, 2024
1 parent 8971a94 commit 9cd89d9
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,25 @@ With LogCraft CLI, you can easily deploy your security detections into your SIEM

- **v0.1.0:** 2024-06-24, initial stable release.

## Download LogCraft CLI
To download the latest stable version of LogCraft CLI, simply [go to the release page](https://github.com/LogCraftIO/logcraft-cli/releases) and pick the latest available version for your architecture.

Once downloaded, add the `lgc` binary to your PATH, for example in `/usr/local/bin`

```bash
~$ tar xf lgc-x86_64-unknown-linux-gnu.tar.xz
~$ sudo cp lgc-x86_64-unknown-linux-gnu/lgc /usr/local/bin/
```
Finally, ensure lgc is correctly installed

```bash
~$ cd
~$ lgc --version
LogCraft CLI v0.1.0
~$
```
Congratulation, LogCraft CLI is installed and working :tada:

## Build from sources

```bash
Expand Down

0 comments on commit 9cd89d9

Please sign in to comment.