From c75f9f7de90a61a4370be309cdc827735045045a Mon Sep 17 00:00:00 2001
From: Erin Nova <erin@the-system.eu.org>
Date: Tue, 25 Jul 2023 23:17:40 -0400
Subject: [PATCH] Bump up core version, update README

---
 README.md       | 12 ++++++++++++
 core/Cargo.toml |  2 +-
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 9e3950c..9168d09 100644
--- a/README.md
+++ b/README.md
@@ -18,3 +18,15 @@
 3. Install [sqlx-cli](https://lib.rs/crates/sqlx-cli)
 4. Set the `DATABASE_URL` environment variable to `"sqlite:todos.db"`
 5. Install the [just](https://just.systems/) command runner
+
+### Parts
+The [crawler](/crawler) is a self-contained executable, that when ran crawls through the URLs and inserts them into an **SQL** database.
+
+The engine [core](/core) is a server that hosts an *API* to perform search queries on the database.
+It creates a seperate indexed table in the database, and has a search endpoint at `/api/search`.
+It takes a `POST` request with a *JSON* body, and returns a *JSON* response.
+The variables it takes are:
+    - `language`: an *ISO 639-3* lang code
+    - `include`: the primary search query
+    - `ignore`: keywords to ignore (optional)
+    - `option`: a `SearchType` (`Fuzzy`, `Regex`, `Sql`)
diff --git a/core/Cargo.toml b/core/Cargo.toml
index 28d6f1e..39c75ec 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "core"
-version = "0.1.0"
+version = "0.2.0"
 edition.workspace = true
 authors.workspace = true
 homepage.workspace = true