diff --git a/README.md b/README.md index f934c81..5dff0b5 100644 --- a/README.md +++ b/README.md @@ -28,6 +28,34 @@ Created by Luxferre in 2026, released into the public domain. --- +## Installation + +### Via `go install` + +Install directly to `$(go env GOPATH)/bin`: + +```bash +go install code.luxferre.top/luxferre/qflash@latest +``` + +*Note: If installing right after pushing to Gitea, bypass any public module proxy cache by using `GOPROXY=direct`:* + +```bash +GOPROXY=direct go install code.luxferre.top/luxferre/qflash@latest +``` + +### From Source + +```bash +git clone https://code.luxferre.top/luxferre/qflash.git +cd qflash +make qflash +``` + +The resulting binary will be placed at `bin/qflash`. + +--- + ## Architecture & Model Aliases The gateway serves the following models under `/v1/models`: @@ -43,24 +71,6 @@ Any unlisted custom model name requested by the client is passed through directl --- -## Build Instructions - -Build binary with Go: - -```bash -make qflash -``` - -Or run test suite: - -```bash -make test -``` - -The resulting binary will be placed at `bin/qflash`. - ---- - ## Configuration Flags & Environment Variables | Flag | Shorthand | Environment Variable | Default | Description | @@ -82,7 +92,7 @@ The resulting binary will be placed at `bin/qflash`. ### 1. Launch Gateway ```bash -./bin/qflash -port 8080 +qflash -port 8080 ``` ### 2. List Models diff --git a/go.mod b/go.mod index 62b2fdc..11db31e 100644 --- a/go.mod +++ b/go.mod @@ -1,3 +1,3 @@ -module qflash +module code.luxferre.top/luxferre/qflash go 1.22