Skip to content

Commit 81ba42e

Browse files
committed
docs(README): update community fork notice
- Remove "temporary fork" framing since upstream is inactive - Condense credits with accurate PR count (15+) - Add memory leak fixes to fork improvements list - Clean up bullet points and grammar
1 parent 3e6e825 commit 81ba42e

File tree

1 file changed

+11
-13
lines changed

1 file changed

+11
-13
lines changed

README.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,17 @@
33
[![](https://dcbadge.vercel.app/api/server/VCtQ8cGhUs)](https://discord.gg/Ve7WeCJFXk)
44

55
> [!NOTE]
6-
> **Community Fork Notice:** This is a temporary fork of [`asg017/sqlite-vec`](https://github.com/asg017/sqlite-vec)
7-
> - Created to merge pending upstream PRs and provide community support while the original author is unavailable.
8-
> - Once development resumes on the original repository, users are encouraged to switch back.
9-
> - All credit for the original implementation goes to [Alex Garcia](https://github.com/asg017).
10-
> - Credit for creating the fork and merging PRs goes to [Vlad Lasky](https://github.com/vlasky).
11-
>
12-
> This branch includes:
13-
> - Hardening (replaced atoi() with strtol(), vendor.sh SHA validation, pinned GHA versions, OIDC releases)
14-
> - Update to the latest SQLite release (should be no-op, and backward compatible)
15-
> - Node.js release added Alpine/MUSL x64/arm64 and Windows arm64 prebuilds
16-
> - Node.js package now includes all prebuilds (no post-install scripts!)
17-
18-
> Feel free to cherry-pick any changes back upstream -- commits are kept small and isolated for this purpose.
6+
> **Community Fork:** This fork of [`asg017/sqlite-vec`](https://github.com/asg017/sqlite-vec) merges pending upstream PRs and provides continued maintenance while the original repository is inactive.
7+
>
8+
> Credits: [Alex Garcia](https://github.com/asg017) (original implementation), [Vlad Lasky](https://github.com/vlasky) (merged 15+ pending upstream PRs).
9+
>
10+
> **Fork improvements:**
11+
> - Security hardening (safe integer parsing, vendor checksum validation, pinned CI actions, OIDC releases)
12+
> - Fixed multiple memory leaks via AddressSanitizer/Valgrind testing (see [CHANGELOG](CHANGELOG-mceachen.md))
13+
> - Node.js: added Alpine/musl and Windows ARM64 prebuilds, all platforms bundled (no post-install scripts)
14+
> - Updated to latest SQLite release
15+
>
16+
> Commits are kept small for easy cherry-picking back upstream.
1917
2018
An extremely small, "fast enough" vector search SQLite extension that runs
2119
anywhere! A successor to [`sqlite-vss`](https://github.com/asg017/sqlite-vss)

0 commit comments

Comments
 (0)