diff --git a/README.md b/README.md index 9168d09..ca21424 100644 --- a/README.md +++ b/README.md @@ -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