From 568f442d8038f3108fbe60c360136994f5fafecd Mon Sep 17 00:00:00 2001 From: Sergey Polzunov Date: Sun, 25 Feb 2024 21:27:11 +0100 Subject: [PATCH] Updating installation docs (#111) --- docs/install.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/docs/install.md b/docs/install.md index 2feec6ec..eb2d9441 100644 --- a/docs/install.md +++ b/docs/install.md @@ -8,17 +8,33 @@ weight: 2 ## GitHub releases -The archives of compiled binaries for Fabric are available for Windows, macOS, and Linux at the project's ["Releases"](https://github.com/blackstork-io/fabric/releases) page. +The archives of compiled binaries for Fabric and Fabric plugins are available for Windows, macOS, and Linux at the project's ["Releases"](https://github.com/blackstork-io/fabric/releases) page. To get started with Fabric: -- **download release archives**: choose and download the appropriate release for your operating system (Windows, macOS/Darwin, or Linux) and architecture in ["Releases" section](https://github.com/blackstork-io/fabric/releases); +- **download release archives**: choose and download the appropriate Fabric and Fabric plugin releases for your operating system (Windows, macOS/Darwin, or Linux) and architecture from ["Releases" section](https://github.com/blackstork-io/fabric/releases); - **unpack the archives**: extract the contents of the downloaded archives to a preferred directory; -For example, for the macOS you can do: +For example, the steps for macOS (arm64) are: ```bash -TBD +# Create a folder +mkdir fabric-bin + +# Download the latest release of Fabric +wget https://github.com/blackstork-io/fabric/releases/latest/download/fabric_darwin_arm64.tar.gz -O ./fabric_darwin_arm64.tar.gz + +# Download the latest release of Fabric plugins +wget https://github.com/blackstork-io/fabric/releases/latest/download/plugins_darwin_arm64.tar.gz -O ./plugins_darwin_arm64.tar.gz + +# Unpack Fabric release archive into `fabric-bin` folder +tar -xvzf ./fabric_darwin_arm64.tar.gz -C ./fabric-bin + +# Unpack Fabric plugins release archive into `fabric-bin` folder +tar -xvzf ./plugins_darwin_arm64.tar.gz -C ./fabric-bin + +# Verify that `fabric` runs +./fabric-bin/fabric --help ``` That's it! You're now ready to use Fabric. For more details on usage and configuration options, refer [Fabric CLI]({{< ref "cli.md" >}}) documentation.