Fix README format

main
~erin 2023-07-25 23:18:23 -04:00
parent c75f9f7de9
commit 512632d042
Signed by: erin
GPG Key ID: 0FEDEAFF1C14847E
1 changed files with 3 additions and 0 deletions

View File

@ -23,8 +23,11 @@
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