Skip to content

Commit ef37f94

Browse files
committed
chore: clean up README and changelog by removing outdated notes and installation instructions for original package
1 parent 63a9c1e commit ef37f94

2 files changed

Lines changed: 4 additions & 75 deletions

File tree

CHANGELOG.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -335,16 +335,5 @@ These paths were not detected by sanitizers because they were never executed by
335335
## Original Version
336336

337337
This fork is based on [`asg017/sqlite-vec`](https://github.com/asg017/sqlite-vec) v0.1.7-alpha.2.
338-
339338
All features and functionality from the original repository are preserved.
340339
See the [original documentation](https://alexgarcia.xyz/sqlite-vec/) for complete usage information.
341-
342-
---
343-
344-
## Notes
345-
346-
This is a community-maintained fork created to merge pending upstream PRs and provide
347-
continued support while the original author is unavailable. Once development resumes
348-
on the original repository, users are encouraged to switch back.
349-
350-
All original implementation credit goes to [Alex Garcia](https://github.com/asg017).

README.md

Lines changed: 4 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -25,13 +25,6 @@
2525
An extremely small, "fast enough" vector search SQLite extension that runs
2626
anywhere! A successor to [`sqlite-vss`](https://github.com/asg017/sqlite-vss)
2727

28-
<!-- deno-fmt-ignore-start -->
29-
30-
> [!IMPORTANT]
31-
> _`sqlite-vec` is a pre-v1, so expect breaking changes!_
32-
33-
<!-- deno-fmt-ignore-end -->
34-
3528
- Store and query float, int8, and binary vectors in `vec0` virtual tables
3629
- Written in pure C, no dependencies, runs anywhere SQLite runs
3730
(Linux/MacOS/Windows, in the browser with WASM, Raspberry Pis, etc.)
@@ -62,28 +55,9 @@ See <a href="#sponsors">the Sponsors section</a> for more details.
6255

6356
## Installing
6457

65-
### From Original Package Registries
66-
67-
The original packages on PyPI, npm, RubyGems, and crates.io are maintained by the original author.
68-
For the latest features from this fork, see "Installing from This Fork" below.
69-
70-
| Language | Install | More Info | |
71-
| -------------- | ---------------------------------------------------- | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
72-
| Python | `pip install sqlite-vec` | [`sqlite-vec` with Python](https://alexgarcia.xyz/sqlite-vec/python.html) | [![PyPI](https://img.shields.io/pypi/v/sqlite-vec.svg?color=blue&logo=python&logoColor=white)](https://pypi.org/project/sqlite-vec/) |
73-
| Node.js | `npm install sqlite-vec` | [`sqlite-vec` with Node.js](https://alexgarcia.xyz/sqlite-vec/js.html) | [![npm](https://img.shields.io/npm/v/sqlite-vec.svg?color=green&logo=nodedotjs&logoColor=white)](https://www.npmjs.com/package/sqlite-vec) |
74-
| Ruby | `gem install sqlite-vec` | [`sqlite-vec` with Ruby](https://alexgarcia.xyz/sqlite-vec/ruby.html) | ![Gem](https://img.shields.io/gem/v/sqlite-vec?color=red&logo=rubygems&logoColor=white) |
75-
| Rust | `cargo add sqlite-vec` | [`sqlite-vec` with Rust](https://alexgarcia.xyz/sqlite-vec/rust.html) | [![Crates.io](https://img.shields.io/crates/v/sqlite-vec?logo=rust)](https://crates.io/crates/sqlite-vec) |
76-
| Datasette | `datasette install datasette-sqlite-vec` | [`sqlite-vec` with Datasette](https://alexgarcia.xyz/sqlite-vec/datasette.html) | [![Datasette](https://img.shields.io/pypi/v/datasette-sqlite-vec.svg?color=B6B6D9&label=Datasette+plugin&logoColor=white&logo=python)](https://datasette.io/plugins/datasette-sqlite-vec) |
77-
| rqlite | `rqlited -extensions-path=sqlite-vec.tar.gz` | [`sqlite-vec` with rqlite](https://alexgarcia.xyz/sqlite-vec/rqlite.html) | [![rqlite](https://img.shields.io/badge/rqlite-sqlite_extensions-blue)](https://rqlite.io/docs/guides/extensions/) |
78-
| `sqlite-utils` | `sqlite-utils install sqlite-utils-sqlite-vec` | [`sqlite-vec` with sqlite-utils](https://alexgarcia.xyz/sqlite-vec/sqlite-utils.html) | [![sqlite-utils](https://img.shields.io/pypi/v/sqlite-utils-sqlite-vec.svg?color=B6B6D9&label=sqlite-utils+plugin&logoColor=white&logo=python)](https://datasette.io/plugins/datasette-sqlite-vec) |
58+
### Node.js
7959

80-
### Installing from PhotoStructure's Fork
81-
82-
Install directly from npm or GitHub to get PhotoStructure's production-ready fork with additional features and comprehensive testing.
83-
84-
#### Node.js (Recommended)
85-
86-
PhotoStructure publishes prebuilt binaries to npm for all major platforms:
60+
Prebuilt binaries for all major platforms are published to npm:
8761

8862
```bash
8963
npm install @photostructure/sqlite-vec
@@ -93,43 +67,9 @@ npm install @photostructure/sqlite-vec
9367

9468
**Supported platforms:** Linux (x64, ARM64, musl), macOS (x64, ARM64), Windows (x64, ARM64)
9569

96-
#### Other Languages (Build from Source)
97-
98-
| Language | Install Latest (main branch) | Install Specific Version |
99-
|----------|------------------------------|--------------------------|
100-
| **Go** | `go get github.com/photostructure/sqlite-vec/bindings/go/cgo@main` | `go get github.com/photostructure/sqlite-vec/bindings/go/cgo@v0.4.1` |
101-
| **Lua** | `luarocks install lsqlite3` then copy [`sqlite_vec.lua`](bindings/lua/) to your project. See [Lua example](/examples/simple-lua/) | Download [`sqlite_vec.lua` at v0.4.1](https://github.com/photostructure/sqlite-vec/blob/v0.4.1/bindings/lua/sqlite_vec.lua) |
102-
| **Python** | `pip install git+https://github.com/photostructure/sqlite-vec.git` | `pip install git+https://github.com/photostructure/sqlite-vec.git@v0.4.1` |
103-
| **Ruby** | `gem 'sqlite-vec', git: 'https://github.com/photostructure/sqlite-vec'` | `gem 'sqlite-vec', git: 'https://github.com/photostructure/sqlite-vec', tag: 'v0.4.1'` |
104-
| **Rust** | `cargo add sqlite-vec --git https://github.com/photostructure/sqlite-vec` | `cargo add sqlite-vec --git https://github.com/photostructure/sqlite-vec --tag v0.4.1` |
105-
106-
**Python Note:** Requires Python built with loadable extension support (`--enable-loadable-sqlite-extensions`). If you encounter errors:
107-
- Use `uv` to create virtual environments (uses system Python with extension support)
108-
- Or use system Python instead of pyenv/custom builds
109-
- Or rebuild your Python with `./configure --enable-loadable-sqlite-extensions`
110-
111-
**Available version tags:** See [Releases](https://github.com/photostructure/sqlite-vec/releases)
112-
113-
#### Build from Source
114-
115-
For direct C usage or other languages:
116-
117-
```bash
118-
git clone https://github.com/vlasky/sqlite-vec.git
119-
cd sqlite-vec
120-
./scripts/vendor.sh # Download vendored dependencies
121-
make loadable # Builds dist/vec0.so (or .dylib/.dll)
122-
```
123-
124-
#### Not Yet Available
125-
126-
- Pre-built binaries via GitHub Releases
127-
- Package registry publications (PyPI, npm, RubyGems, crates.io)
128-
- Datasette/sqlite-utils plugins
129-
130-
For these, use the original packages until this fork's CI/CD is configured.
70+
### Other Languages
13171

132-
See the [original documentation](https://alexgarcia.xyz/sqlite-vec/installation.html) for detailed usage information.
72+
For Python, Ruby, Rust, Go, and other language bindings, see the original [`asg017/sqlite-vec`](https://github.com/asg017/sqlite-vec) or [Vlad Lasky's fork](https://github.com/vlasky/sqlite-vec). This fork only publishes the Node.js package.
13373

13474
## Electron
13575

0 commit comments

Comments
 (0)