Skip to content

Commit 2567263

Browse files
committed
Update readme
1 parent 390db5e commit 2567263

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
11
# SqliteVec
22

3+
[![Hex Package](https://img.shields.io/hexpm/v/sqlite_vec.svg&style=for-the-badge)](https://hex.pm/packages/sqlite_vec)
4+
[![Hex Docs](https://img.shields.io/badge/hex-docs-blue.svg&style=for-the-badge)](https://hexdocs.pm/sqlite_vec)
5+
[![Build Status](https://github.com/joelpaulkoch/sqlite_vec/workflows/ci/badge.svg&style=for-the-badge)](https://github.com/joelpaulkoch/sqlite_vec/actions)
6+
37
A wrapper to use [sqlite-vec](https://github.com/asg017/sqlite-vec), a SQLite extension for working with vectors, in Elixir.
48
The configured version of the precompiled loadable library will be downloaded from the GitHub releases.
59
Moreover, this package provides structs and custom Ecto types for working with Float32, Int8, and Bit vectors.
610

11+
## Limitations
12+
- it's currently not possible to create int8 and bit vectors using `Ecto`. You must directly use SQL to do so
13+
- not implemented operations: `vec_each`, `vec_quantize_i8`
14+
715
## Installation
816

9-
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
10-
by adding `sqlite_vec` to your list of dependencies in `mix.exs`:
17+
The package can be installed by adding `sqlite_vec` to your list of dependencies in `mix.exs`:
1118

1219
```elixir
1320
def deps do
@@ -17,10 +24,6 @@ def deps do
1724
end
1825
```
1926

20-
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
21-
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
22-
be found at <https://hexdocs.pm/sqlite_vec>.
23-
2427
## Getting Started
2528

2629
`SqliteVec.path/0` returns the path of the downloaded library.

0 commit comments

Comments
 (0)