Bump up core version, update README
parent
3ccbb09c26
commit
c75f9f7de9
12
README.md
12
README.md
|
@ -18,3 +18,15 @@
|
||||||
3. Install [sqlx-cli](https://lib.rs/crates/sqlx-cli)
|
3. Install [sqlx-cli](https://lib.rs/crates/sqlx-cli)
|
||||||
4. Set the `DATABASE_URL` environment variable to `"sqlite:todos.db"`
|
4. Set the `DATABASE_URL` environment variable to `"sqlite:todos.db"`
|
||||||
5. Install the [just](https://just.systems/) command runner
|
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`)
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
[package]
|
[package]
|
||||||
name = "core"
|
name = "core"
|
||||||
version = "0.1.0"
|
version = "0.2.0"
|
||||||
edition.workspace = true
|
edition.workspace = true
|
||||||
authors.workspace = true
|
authors.workspace = true
|
||||||
homepage.workspace = true
|
homepage.workspace = true
|
||||||
|
|
Loading…
Reference in New Issue