From 729d8d590425ca79c919ffbd4061e86ce183a4c8 Mon Sep 17 00:00:00 2001 From: Qinren Zhou Date: Fri, 13 Feb 2026 14:04:58 +0800 Subject: [PATCH] minor: add installation instruction for node.js package (#103) --- README.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 4a9f961..96d91f5 100644 --- a/README.md +++ b/README.md @@ -30,25 +30,33 @@ ## 💫 Features - **Blazing Fast**: Searches billions of vectors in milliseconds. -- **Simple, Just Works**: Install with `pip install zvec` and start searching in seconds. No servers, no config, no fuss. +- **Simple, Just Works**: [Install](#-installation) and start searching in seconds. No servers, no config, no fuss. - **Dense + Sparse Vectors**: Work with both dense and sparse embeddings, with native support for multi-vector queries in a single call. - **Hybrid Search**: Combine semantic similarity with structured filters for precise results. - **Runs Anywhere**: As an in-process library, Zvec runs wherever your code runs — notebooks, servers, CLI tools, or even edge devices. ## 📦 Installation -Install Zvec from PyPI with a single command: +### Python + +**Requirements**: Python 3.10 - 3.12 ```bash pip install zvec ``` -**Requirements**: +### Node.js -- Python 3.10 - 3.12 -- **Supported platforms**: - - Linux (x86_64/ARM64) - - macOS (ARM64) +```bash +npm install @zvec/zvec +``` + +### ✅ Supported Platforms + +- Linux (x86_64, ARM64) +- macOS (ARM64) + +### 🛠️ Building from Source If you prefer to build Zvec from source, please check the [Building from Source](https://zvec.org/en/docs/build/) guide. @@ -100,11 +108,11 @@ Stay updated and get support — scan or click:
💬 DingTalk
- + DingTalk QR Code
📱 WeChat
- + WeChat QR Code
🎮 Discord