Add the logos to the README and docs

meilisearch · Nov 26, 2023 · b6867c1 · b6867c1
1 parent cb32175
commit b6867c1
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -1,4 +1,5 @@
-# arroy
+<p align="center"><img width="280px" title="The arroy logo is electric like LMDB and made up of colored clusters (of vectors)" src="https://raw.githubusercontent.com/meilisearch/arroy/main/assets/arroy-electric-clusters-logo.png"></a>
+<h1 align="center">arroy</h1>
 
 [![License](https://img.shields.io/badge/license-MIT-green)](#LICENSE)
 [![Crates.io](https://img.shields.io/crates/v/arroy)](https://crates.io/crates/arroy)

diff --git a/assets/arroy-electric-clusters-logo.png b/assets/arroy-electric-clusters-logo.png
diff --git a/assets/arroy-electric-clusters.ico b/assets/arroy-electric-clusters.ico
diff --git a/src/lib.rs b/src/lib.rs
@@ -1,3 +1,10 @@
+#![doc(
+    html_favicon_url = "https://raw.githubusercontent.com/meilisearch/arroy/main/assets/arroy-electric-clusters.ico?raw=true"
+)]
+#![doc(
+    html_logo_url = "https://raw.githubusercontent.com/meilisearch/arroy/main/assets/arroy-electric-clusters-logo.png?raw=true"
+)]
+
 mod distance;
 mod error;
 mod item_iter;