From 007511f99af07ba89c9a47dddeafe0ed227783a1 Mon Sep 17 00:00:00 2001 From: Micaiah Reid Date: Fri, 5 Jul 2024 11:25:02 -0400 Subject: [PATCH] docs: update installation instructions (#614) --- README.md | 30 ++++++++++++++++++++++++++++-- 1 file changed, 28 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 49da6af87..8dc8cfa68 100644 --- a/README.md +++ b/README.md @@ -16,9 +16,35 @@ Benefits are plurals: - Cost Optimization for data storage management and scaling. --- -## Install chainhook +## Install Chainhook -### Install from the source +There are a few options when installing Chainhook. + +### macOS +Chainhook can be installed on macOS using Homebrew with the following command: +```terminal +brew install chainhook +``` + +### Linux +Chainhook is also available on the [snap store](https://snapcraft.io/chainhook) for Linux users. +To install, run: +```terminal +sudo snap install chainhook +``` + +### Windows +Windows users can install via winget: +``` +winget install HiroSystems.Chainhook +``` + +### Download Builds +If you don't like using package managers and want to download our builds directly, they are published to our [release page](https://github.com/hirosystems/chainhook/releases). + +### Install from Source + +Finally, you can also build our source code directly: ```bash $ git clone https://github.com/hirosystems/chainhook.git