Skip to content

Commit dec4d77

Browse files
authored
Update docs, roadmap in README (#92)
1 parent 51cc1fd commit dec4d77

1 file changed

Lines changed: 19 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
<p align="center">
66
<a href="https://github.com/sdslabs/VortexDB/actions"><img src="https://img.shields.io/github/actions/workflow/status/sdslabs/VortexDB/rust.yml?branch=refactor&style=flat-square&label=build" alt="Build Status"></a>
7-
<a href="#"><img src="https://img.shields.io/badge/docs-coming%20soon-yellow?style=flat-square" alt="Docs"></a>
7+
<a href="https://vortex-db.sdslabs.co/"><img src="https://img.shields.io/badge/docs-vortex--db.sdslabs.co-00d4aa?style=flat-square" alt="Docs"></a>
88
<a href="LICENSE"><img src="https://img.shields.io/badge/license-Apache%202.0-blue?style=flat-square" alt="License"></a>
99
<a href="https://discord.gg/dXkVEgTPu9"><img src="https://img.shields.io/discord/758961084337618944?style=flat-square&logo=discord&label=discord" alt="Discord"></a>
1010
</p>
@@ -13,6 +13,19 @@
1313

1414
---
1515

16+
## Documentation
17+
18+
Full documentation lives at **[vortex-db.sdslabs.co](https://vortex-db.sdslabs.co/)**:
19+
20+
- [Installation](https://vortex-db.sdslabs.co/getting-started/installation) and [Quickstart](https://vortex-db.sdslabs.co/getting-started/quickstart)
21+
- Concepts: [Architecture](https://vortex-db.sdslabs.co/concepts/architecture), [Indexers](https://vortex-db.sdslabs.co/concepts/indexers), [Snapshots](https://vortex-db.sdslabs.co/concepts/snapshots)
22+
- API reference: [overview](https://vortex-db.sdslabs.co/api-reference/overview), [HTTP](https://vortex-db.sdslabs.co/api-reference/http), [gRPC](https://vortex-db.sdslabs.co/api-reference/grpc)
23+
- Python SDK: [reference](https://vortex-db.sdslabs.co/sdk/reference) and [examples](https://vortex-db.sdslabs.co/sdk/examples)
24+
25+
The sources for the site are in [`docs/`](docs).
26+
27+
---
28+
1629
## Architecture
1730

1831
VortexDB is organized as a Rust workspace with modular crates for flexibility and maintainability.
@@ -25,7 +38,7 @@ Supported distance metrics include Euclidean, Manhattan, Hamming, and Cosine sim
2538

2639
### Storage Engine
2740

28-
The storage layer abstracts persistence with a `StorageEngine` trait, allowing different backends. **RocksDB** offers persistent, production-ready storage for real-world deployments.
41+
The storage layer abstracts persistence with a `StorageEngine` trait, allowing different backends. **RocksDB** offers persistent, production-ready storage for real-world deployments, while **InMemory** keeps points in process for tests and ephemeral workloads.
2942

3043

3144

@@ -119,10 +132,11 @@ DISABLE_HTTP=true docker compose up
119132

120133
## Roadmap
121134

122-
- [ ] InMemory implementation of StorageEngine
123-
- [ ] Snapshots for indexers
135+
- [x] InMemory implementation of StorageEngine
136+
- [x] Snapshots for indexers
137+
- [x] Python SDK — sync and async clients ([`client/python`](client/python))
138+
- [x] API key authentication for the HTTP and gRPC servers
124139
- [ ] Benchmarking suite
125-
- [ ] Python SDK
126140
- [ ] JavaScript/TypeScript SDK
127141
- [ ] Modular vectorization service
128142

0 commit comments

Comments
 (0)