From ebb24948795dc3bb6f3b965dc4e1af3ce8b29e50 Mon Sep 17 00:00:00 2001
From: Kerollmops <clement@meilisearch.com>
Date: Mon, 16 Jan 2023 16:25:12 +0100
Subject: [PATCH] Add a README to the milli crate

---
 assets/{logo-black.svg => milli-logo.svg} |  0
 milli/README.md                           | 16 ++++++++++++++++
 2 files changed, 16 insertions(+)
 rename assets/{logo-black.svg => milli-logo.svg} (100%)
 create mode 100644 milli/README.md

diff --git a/assets/logo-black.svg b/assets/milli-logo.svg
similarity index 100%
rename from assets/logo-black.svg
rename to assets/milli-logo.svg
diff --git a/milli/README.md b/milli/README.md
new file mode 100644
index 000000000..8f04d04dc
--- /dev/null
+++ b/milli/README.md
@@ -0,0 +1,16 @@
+<p align="center">
+  <img alt="the milli logo" src="../assets/milli-logo.svg">
+</p>
+
+<p align="center">a concurrent indexer combined with fast and relevant search algorithms</p>
+
+## Introduction
+
+This crate contains the internal engine used by [Meilisearch].
+
+It contains a library that can manage one and only one index. Meilisearch
+manages the multi-index itself. Milli is unable to store updates in a store:
+it is the job of something else above and this is why it is only able
+to process one update at a time.
+
+[Meilisearch]: https://github.com/meilisearch/meilisearch