diff --git a/README.md b/README.md index d2d85a5..fee46eb 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@

- Kdrant — an idiomatic, coroutine-first Kotlin client for Qdrant + Kdrant — a coroutine-first Kotlin client for the Qdrant vector database

# Kdrant @@ -7,10 +7,10 @@ **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. @@ -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 diff --git a/docs/brand/README.md b/docs/brand/README.md new file mode 100644 index 0000000..1b1606b --- /dev/null +++ b/docs/brand/README.md @@ -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. diff --git a/docs/brand/kdrant-favicon-512.png b/docs/brand/kdrant-favicon-512.png new file mode 100644 index 0000000..67f85e4 Binary files /dev/null and b/docs/brand/kdrant-favicon-512.png differ diff --git a/docs/brand/kdrant-favicon-light.svg b/docs/brand/kdrant-favicon-light.svg new file mode 100644 index 0000000..62655fe --- /dev/null +++ b/docs/brand/kdrant-favicon-light.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/brand/kdrant-favicon.svg b/docs/brand/kdrant-favicon.svg new file mode 100644 index 0000000..43d0bc8 --- /dev/null +++ b/docs/brand/kdrant-favicon.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/brand/kdrant-lockup-dark.svg b/docs/brand/kdrant-lockup-dark.svg new file mode 100644 index 0000000..9bdf7cd --- /dev/null +++ b/docs/brand/kdrant-lockup-dark.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/brand/kdrant-lockup-light.svg b/docs/brand/kdrant-lockup-light.svg new file mode 100644 index 0000000..58bf081 --- /dev/null +++ b/docs/brand/kdrant-lockup-light.svg @@ -0,0 +1,14 @@ + + + + + + + + + + + + + + diff --git a/docs/brand/kdrant-lockup-mono-dark.svg b/docs/brand/kdrant-lockup-mono-dark.svg new file mode 100644 index 0000000..b5314eb --- /dev/null +++ b/docs/brand/kdrant-lockup-mono-dark.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/brand/kdrant-lockup-mono-light.svg b/docs/brand/kdrant-lockup-mono-light.svg new file mode 100644 index 0000000..4a3858a --- /dev/null +++ b/docs/brand/kdrant-lockup-mono-light.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/brand/kdrant-social-preview.png b/docs/brand/kdrant-social-preview.png new file mode 100644 index 0000000..3af1067 Binary files /dev/null and b/docs/brand/kdrant-social-preview.png differ diff --git a/docs/brand/kdrant-symbol-mono.svg b/docs/brand/kdrant-symbol-mono.svg new file mode 100644 index 0000000..c498c8a --- /dev/null +++ b/docs/brand/kdrant-symbol-mono.svg @@ -0,0 +1,8 @@ + + + + + + + + diff --git a/docs/brand/kdrant-symbol.svg b/docs/brand/kdrant-symbol.svg new file mode 100644 index 0000000..87c9e3c --- /dev/null +++ b/docs/brand/kdrant-symbol.svg @@ -0,0 +1,13 @@ + + + + + + + + + + + + + diff --git a/docs/brand/kdrant-tokens.css b/docs/brand/kdrant-tokens.css new file mode 100644 index 0000000..2edd123 --- /dev/null +++ b/docs/brand/kdrant-tokens.css @@ -0,0 +1,41 @@ +:root { + /* surfaces */ + --kd-void: #05060B; + --kd-surface: #0B0E17; + --kd-raised: #121728; + --kd-line: #1A2036; + --kd-line-strong: #232B45; + /* text */ + --kd-ice: #EEF1F8; + --kd-text: #C3CADD; + --kd-muted: #8A94B2; + --kd-faint: #5C6788; + /* accents */ + --kd-violet: #A855F7; + --kd-purple: #7F52FF; + --kd-blue: #2FB2FF; + --kd-signal: #34D399; + --kd-fault: #FB7185; + --kd-warn: #E9A23B; + --kd-gradient: linear-gradient(96deg, #A855F7, #7F52FF, #2FB2FF); + /* type */ + --kd-font-sans: 'Space Grotesk', system-ui, sans-serif; + --kd-font-mono: 'JetBrains Mono', ui-monospace, monospace; + --kd-display: 700 76px/0.96 var(--kd-font-sans); + --kd-h2: 600 30px/1.2 var(--kd-font-sans); + --kd-h3: 600 20px/1.3 var(--kd-font-sans); + --kd-body: 400 17px/1.65 var(--kd-font-sans); + --kd-eyebrow-size: 12px; + --kd-eyebrow-tracking: .30em; + --kd-display-tracking: -.035em; + --kd-wordmark-tracking: -.055em; + /* space */ + --kd-s1: 4px; --kd-s2: 8px; --kd-s3: 16px; --kd-s4: 28px; --kd-s5: 48px; --kd-s6: 84px; + /* radius */ + --kd-r-chip: 6px; --kd-r-field: 12px; --kd-r-card: 16px; --kd-r-pill: 999px; + /* elevation — light comes from the accent, not from above */ + --kd-e1: 0 0 0 1px var(--kd-line); + --kd-e2: 0 12px 32px rgba(0,0,0,.55); + --kd-e3: 0 0 0 1px rgba(127,82,255,.18), 0 0 36px rgba(127,82,255,.28); + --kd-focus: 0 0 0 3px rgba(127,82,255,.18); +} diff --git a/docs/kdrant-hero.png b/docs/kdrant-hero.png index 2c4f58d..f62e986 100644 Binary files a/docs/kdrant-hero.png and b/docs/kdrant-hero.png differ