From 09b56b50960ec301c79ad897c062f09ff6362637 Mon Sep 17 00:00:00 2001 From: Erin Nova Date: Tue, 25 Jul 2023 23:19:23 -0400 Subject: [PATCH] whoops --- README.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index ca21424..f880d35 100644 --- a/README.md +++ b/README.md @@ -20,16 +20,14 @@ 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. +The `crawler` is a self-contained executable, that when ran crawls through the URLs and inserts them into an **SQL** database. +The engine `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`) +- `language`: an *ISO 639-3* lang code +- `include`: the primary search query +- `ignore`: keywords to ignore (optional) +- `option`: a `SearchType` (`Fuzzy`, `Regex`, `Sql`)