From b96b543394c1dff79ba5fb09a86e81fe25f8652f Mon Sep 17 00:00:00 2001 From: Christopher Maher Date: Sun, 17 May 2026 14:06:33 -0700 Subject: [PATCH] docs: add Homebrew install instructions mlx-server now ships a Homebrew formula. Add an Install section leading with 'brew install defilantech/tap/mlx-server' and rename the former 'Build and run' section to 'Build from source', since building from source is now the alternative path, not the only one. Signed-off-by: Christopher Maher --- README.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fbc30c..8acc216 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,21 @@ The end goal is to be a drop-in replacement for `llama-server` in [LLMKube](http [TheTom's MLXServer](https://github.com/ekryski/mlx-swift-lm/tree/ek/tom-eric-moe-tuning/Sources/MLXServer) (abandoned in favor of vllm-swift) was the proof-of-concept that an MLX-swift HTTP server is feasible. Several design decisions here, particularly around the slot manager and longest-prefix KV cache, are informed by his approach. The decision to rebuild rather than fork is mainly because his original used hand-rolled socket code; this repo uses [Hummingbird](https://github.com/hummingbird-project/hummingbird) for the HTTP layer. -## Build and run +## Install + +```bash +brew install defilantech/tap/mlx-server +``` + +Apple Silicon, macOS 14 (Sonoma) or later. This installs the latest prebuilt +release; older versions and the raw tarballs are on the +[releases page](https://github.com/defilantech/mlx-server/releases). Then: + +```bash +mlx-server --model /path/to/mlx-model-dir --port 8080 +``` + +## Build from source Requires: - macOS 14 (Sonoma) or later, Apple Silicon