diff --git a/README.md b/README.md index c6094ec..26335a6 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@
@@ -13,6 +13,19 @@ --- +## Documentation + +Full documentation lives at **[vortex-db.sdslabs.co](https://vortex-db.sdslabs.co/)**: + +- [Installation](https://vortex-db.sdslabs.co/getting-started/installation) and [Quickstart](https://vortex-db.sdslabs.co/getting-started/quickstart) +- 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) +- 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) +- Python SDK: [reference](https://vortex-db.sdslabs.co/sdk/reference) and [examples](https://vortex-db.sdslabs.co/sdk/examples) + +The sources for the site are in [`docs/`](docs). + +--- + ## Architecture 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 ### Storage Engine -The storage layer abstracts persistence with a `StorageEngine` trait, allowing different backends. **RocksDB** offers persistent, production-ready storage for real-world deployments. +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. @@ -119,10 +132,11 @@ DISABLE_HTTP=true docker compose up ## Roadmap -- [ ] InMemory implementation of StorageEngine -- [ ] Snapshots for indexers +- [x] InMemory implementation of StorageEngine +- [x] Snapshots for indexers +- [x] Python SDK — sync and async clients ([`client/python`](client/python)) +- [x] API key authentication for the HTTP and gRPC servers - [ ] Benchmarking suite -- [ ] Python SDK - [ ] JavaScript/TypeScript SDK - [ ] Modular vectorization service