feat: complete MVP — all 14 tasks done

- Task 13: Full documentation (README, INSTALLATION, USAGE, ARCHITECTURE) - Task 14: Release prep (CHANGELOG, RELEASE_CHECKLIST) - Update PROJECT_STATE.md to reflect 100% completion
2026-06-23 14:06:31 +07:00
parent c2d6aabea0
commit 48c858df0f
7 changed files with 608 additions and 186 deletions
@@ -0,0 +1,113 @@
+# Installation Guide
+
+## Prerequisites
+
+- **Go 1.21+** — for building from source
+- **Git** — for cloning the repository
+- **Make** — optional, for build automation
+
+## Installation Methods
+
+### Method 1: Build from Source
+
+```bash
+git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
+cd hostkeeper
+make build
+sudo cp bin/hostkeeper /usr/local/bin/
+```
+
+### Method 2: Go Install
+
+```bash
+go install git.tukangketik.id/swanadiva/hostkeeper/cmd/hostkeeper@latest
+```
+
+This installs to `$GOPATH/bin` or `$HOME/go/bin`.
+
+### Method 3: Cross-Platform Build
+
+```bash
+./build.sh
+```
+
+Binaries will be in the `build/` directory with SHA256 checksums.
+
+## Platform-Specific Instructions
+
+### macOS
+
+```bash
+# Install Go via Homebrew
+brew install go
+
+# Build and install
+git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
+cd hostkeeper
+make build
+cp bin/hostkeeper /usr/local/bin/
+```
+
+### Linux (Ubuntu/Debian)
+
+```bash
+# Install Go
+sudo apt update
+sudo apt install golang git make
+
+# Build and install
+git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
+cd hostkeeper
+make build
+sudo cp bin/hostkeeper /usr/local/bin/
+```
+
+### Windows
+
+```powershell
+# Install Go from https://golang.org/dl/
+# Clone repository
+git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
+cd hostkeeper
+
+# Build
+go build -o hostkeeper.exe ./cmd/hostkeeper
+```
+
+### Termux (Android)
+
+```bash
+pkg install golang git make
+git clone https://git.tukangketik.id/swanadiva/HostKeeper.git
+cd hostkeeper
+make build
+cp bin/hostkeeper $PREFIX/bin/
+```
+
+## Verification
+
+```bash
+hostkeeper version
+```
+
+Expected output:
+```
+hostkeeper dev (built: ...)
+```
+
+## Troubleshooting
+
+### Command Not Found
+
+Ensure the binary is in your PATH:
+```bash
+export PATH=$PATH:/usr/local/bin
+```
+
+### Build Failures
+
+```bash
+make clean
+make deps
+make build
+```