chore: installation guideline (#12)

Author: Ubisoft-potato

.goreleaser.yml

@@ -76,7 +76,7 @@ brews:
       token: "{{ .Env.GITHUB_TOKEN }}"
       branch: main
     license: Apache 2.0
-    directory: brew-formula
+    directory: Formula
     url_template: "https://github.com/bucketeer-io/code-refs/releases/download/{{ .Tag }}/{{ .ArtifactName }}"
     install: |
       bin.install "bucketeer-find-code-refs"

brew-formula/bucketeer-find-code-refs.rb Formula/bucketeer-find-code-refs.rbbrew-formula/bucketeer-find-code-refs.rb renamed to Formula/bucketeer-find-code-refs.rb

@@ -13,7 +13,7 @@ This repository provides solutions for configuring [Bucketeer code references](h
     - [Linux](#linux)
     - [Windows](#windows)
     - [Docker](#docker)
-- [Configuration](#cli-configuration)
+- [Configuration](#configuration)
   - [Required arguments](docs/CONFIGURATION.md#required-arguments)
   - [All arguments](docs/CONFIGURATION.md#command-line)
   - [Using environment variables](docs/CONFIGURATION.md#environment-variables)
@@ -36,25 +36,36 @@ If you are scanning a git repository, `bucketeer-code-refs` requires git (tested
 #### macOS
 
 ```bash
-# TODO: Add installation instructions for macOS
+brew tap bucketeer-io/code-refs https://github.com/bucketeer-io/code-refs
+brew install bucketeer-find-code-refs
 ```
 
+You can now run `bucketeer-find-code-refs`.
+
 #### Linux
 
+Supports `x86_64`, `arm64`, and `i386`. The script auto-detects your architecture and installs via `dpkg`, `rpm`, or a binary depending on your system.
+
 ```bash
-# TODO: Add installation instructions for Linux
+curl -sfL https://raw.githubusercontent.com/bucketeer-io/code-refs/main/scripts/install.sh | bash
 ```
 
+You can now run `bucketeer-find-code-refs`.
+
 #### Windows
 
-```bash
-# TODO: Add installation instructions for Windows
-```
+A Windows executable of `bucketeer-find-code-refs` is available on the [releases page](https://github.com/bucketeer-io/code-refs/releases/latest).
 
 #### Docker
 
+`bucketeer-find-code-refs` is available as a Docker image on the GitHub Container Registry. The image provides an entrypoint for `bucketeer-find-code-refs`, to which command line arguments may be passed. Your repository to be scanned should be mounted as a volume.
+
 ```bash
-# TODO: Add Docker instructions
+docker pull ghcr.io/bucketeer-io/bucketeer-find-code-refs:latest
+docker run \
+  -v /path/to/your/repo:/repo \
+  ghcr.io/bucketeer-io/bucketeer-find-code-refs:latest \
+  --dir="/repo"
 ```
 
 ### Configuration

README.md

@@ -0,0 +1,69 @@
+#!/bin/bash
+set -euo pipefail
+
+REPO="bucketeer-io/code-refs"
+BINARY="bucketeer-find-code-refs"
+
+# Detect OS
+OS=$(uname -s)
+if [ "$OS" != "Linux" ]; then
+    echo "This script supports Linux only."
+    echo "For macOS, use Homebrew:"
+    echo "  brew tap bucketeer-io/code-refs https://github.com/bucketeer-io/code-refs"
+    echo "  brew install bucketeer-find-code-refs"
+    exit 1
+fi
+
+# Detect architecture
+ARCH=$(uname -m)
+case "$ARCH" in
+    x86_64)        PKG_ARCH="amd64"; TAR_ARCH="amd64" ;;
+    aarch64|arm64) PKG_ARCH="arm64"; TAR_ARCH="arm64" ;;
+    i386|i686)     PKG_ARCH="i386";  TAR_ARCH="386"   ;;
+    *)
+        echo "Unsupported architecture: $ARCH"
+        exit 1
+        ;;
+esac
+
+# Get latest version from GitHub
+VERSION=$(curl -sf "https://api.github.com/repos/$REPO/releases/latest" \
+    | grep '"tag_name"' | cut -d'"' -f4)
+VERSION_NUM="${VERSION#v}"
+
+echo "Installing $BINARY $VERSION for Linux/$ARCH..."
+
+BASE_URL="https://github.com/$REPO/releases/download/$VERSION"
+
+install_deb() {
+    TMP=$(mktemp /tmp/bucketeer-code-refs.XXXXXX.deb)
+    curl -sfL "$BASE_URL/code-refs_${VERSION_NUM}.${PKG_ARCH}.deb" -o "$TMP"
+    dpkg -i "$TMP"
+    rm -f "$TMP"
+}
+
+install_rpm() {
+    TMP=$(mktemp /tmp/bucketeer-code-refs.XXXXXX.rpm)
+    curl -sfL "$BASE_URL/code-refs_${VERSION_NUM}.${PKG_ARCH}.rpm" -o "$TMP"
+    rpm -i "$TMP"
+    rm -f "$TMP"
+}
+
+install_tar() {
+    TMP_DIR=$(mktemp -d)
+    curl -sfL "$BASE_URL/code-refs_${VERSION_NUM}_linux_${TAR_ARCH}.tar.gz" \
+        | tar -xz -C "$TMP_DIR"
+    install -m 755 "$TMP_DIR/$BINARY" /usr/local/bin/
+    rm -rf "$TMP_DIR"
+}
+
+if command -v dpkg &>/dev/null; then
+    install_deb
+elif command -v rpm &>/dev/null; then
+    install_rpm
+else
+    install_tar
+fi
+
+echo ""
+echo "$BINARY $VERSION installed successfully!"