Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<p align="center">
<img src="docs/kdrant-hero.png" alt="Kdrant — an idiomatic, coroutine-first Kotlin client for Qdrant" width="100%">
<img src="docs/kdrant-hero.png" alt="Kdrant — a coroutine-first Kotlin client for the Qdrant vector database" width="100%">
</p>

# Kdrant

**An idiomatic, coroutine-first Kotlin client for the [Qdrant](https://qdrant.tech) vector database.**

[![CI](https://github.com/NaCode-Studios/Kdrant/actions/workflows/ci.yml/badge.svg)](https://github.com/NaCode-Studios/Kdrant/actions/workflows/ci.yml)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.nacode-studios/kdrant-core?label=Maven%20Central)](https://central.sonatype.com/artifact/io.github.nacode-studios/kdrant-core)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
[![Kotlin](https://img.shields.io/badge/Kotlin-2.4-7F52FF.svg?logo=kotlin)](https://kotlinlang.org)
[![API docs](https://img.shields.io/badge/API%20docs-Dokka-blue.svg)](https://nacode-studios.github.io/Kdrant/)
[![Maven Central](https://img.shields.io/maven-central/v/io.github.nacode-studios/kdrant-core?label=Maven%20Central&labelColor=0B0E17&color=7F52FF)](https://central.sonatype.com/artifact/io.github.nacode-studios/kdrant-core)
[![License](https://img.shields.io/badge/license-Apache%202.0-232B45?labelColor=0B0E17)](LICENSE)
[![Kotlin](https://img.shields.io/badge/Kotlin-2.4-7F52FF?logo=kotlin&logoColor=white&labelColor=0B0E17)](https://kotlinlang.org)
[![API docs](https://img.shields.io/badge/API%20docs-Dokka-232B45?labelColor=0B0E17)](https://nacode-studios.github.io/Kdrant/)

Qdrant's official JVM client is built for Java: every call returns a `ListenableFuture`, requests
are assembled with protobuf builders, and it pulls a large gRPC/Netty stack onto your classpath.
Expand Down Expand Up @@ -322,7 +322,8 @@ updated `*.api` files.

## License

Licensed under the [Apache License 2.0](LICENSE).
Licensed under the [Apache License 2.0](LICENSE). Brand assets — wordmark, symbol, and the colour and
type tokens — are in [`docs/brand`](docs/brand).

## Sponsor

Expand Down
36 changes: 36 additions & 0 deletions docs/brand/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Kdrant brand assets

The logo is the whole name — **KDRANT** — cut by a single diagonal hyperplane. The lower half slides
along the cut, and the cut itself is filled with the signature gradient (`#A855F7 → #7F52FF → #2FB2FF`),
masked by the letters so it never runs past the last one. The K on its own is a tile, not the logo.

| File | Use |
| --- | --- |
| `kdrant-lockup-dark.svg` | the logo on a dark surface |
| `kdrant-lockup-light.svg` | the logo on a light surface |
| `kdrant-lockup-mono-dark.svg` / `-mono-light.svg` | one flat ink, no gradient |
| `kdrant-symbol.svg` / `kdrant-symbol-mono.svg` | the offset K on its own — internal use |
| `kdrant-favicon.svg` / `-light.svg` / `kdrant-favicon-512.png` | favicon, avatar, app icon |
| `kdrant-social-preview.png` | the GitHub social preview (2560×1280) |
| `kdrant-tokens.css` | colour, type, space, radius and elevation tokens |
| [`../kdrant-hero.png`](../kdrant-hero.png) | the README banner (2560×680) |

Every SVG here is self-contained — the wordmark is outlined, so it renders identically whether or not
Space Grotesk is installed.

**Construction** — Space Grotesk 700, uppercase, tracking `-0.055em`. The cut runs from 60% of the cap
height on the left to 44% on the right; the lower half offsets by 28% of the body across and 6.5% down;
the gradient band in the cut is about 6% of the cap height. Clear space is half the cap height. Minimum
size is 18px of body — below that, only the K in its tile.

**Type** — Space Grotesk 700 (headings and wordmark), Space Grotesk 400 (body), JetBrains Mono (code,
versions, labels).

**Colour** — surfaces Void `#05060B`, Surface `#0B0E17`, Raised `#121728`; borders `#1A2036`; text Ice
`#EEF1F8`. The accent is Kotlin Purple `#7F52FF` between Violet `#A855F7` and Vector Blue `#2FB2FF`;
Signal `#34D399`, Fault `#FB7185`. The signature gradient appears **once per surface** — the logo, the
primary action, or a single thread of accent. Never as a page background, never under text.

**Don't** — use the K alone as the logo · rotate, skew or stretch the wordmark · change the angle of the
cut · let the gradient leave the letters · add a shadow, an outline or a second gradient · swap the
typeface or alter the tracking · set the name in lowercase inside the lockup.
Binary file added docs/brand/kdrant-favicon-512.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/brand/kdrant-favicon-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/brand/kdrant-favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/brand/kdrant-lockup-dark.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/brand/kdrant-lockup-light.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading