minor: add installation instruction for node.js package (#103)
This commit is contained in:
parent
1d5aeeed1d
commit
729d8d5904
26
README.md
26
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:
|
|||
<tr>
|
||||
<td align="center" style="padding: 8px; width: 25%;">
|
||||
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">💬 DingTalk</div>
|
||||
<img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/dingding.png" width="100" style="border-radius: 8px; border: 1px solid #ddd;">
|
||||
<img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/dingding.png" alt="DingTalk QR Code" width="100" style="border-radius: 8px; border: 1px solid #ddd;">
|
||||
</td>
|
||||
<td align="center" style="padding: 8px; width: 25%;">
|
||||
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">📱 WeChat</div>
|
||||
<img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/wechat.png" width="100" style="border-radius: 8px; border: 1px solid #ddd;">
|
||||
<img src="https://zvec.oss-cn-hongkong.aliyuncs.com/qrcode/wechat.png" alt="WeChat QR Code" width="100" style="border-radius: 8px; border: 1px solid #ddd;">
|
||||
</td>
|
||||
<td align="center" style="padding: 8px; width: 25%;">
|
||||
<div style="font-weight: 600; font-size: 14px; margin-bottom: 6px;">🎮 Discord</div>
|
||||
|
|
|
|||
Loading…
Reference in New Issue