Skip to content

docs: Update README with meili + typesense #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sarina merged 2 commits into from
Apr 7, 2026
Merged

docs: Update README with meili + typesense #260

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ddf93e
docs: Update README with meili + typesense
sarina Apr 7, 2026
70cf6a4
docs: Update README with meili + typesense
sarina Apr 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,12 @@ This is a django application to provide access to search services from within ed
Searching is accomplished by creating an index of documents, and then searching within that index for matching information. This application provides a way to add documents to the index, and then search for them.

## SearchEngine
The SearchEngine is an abstract object which may have multiple implementations _(at the time of writing there are 2 in existence - Elasticsearch and MockSearchEngine, which is primarily used for testing)_
The SearchEngine is an abstract object which may have multiple implementations. As of Verawood, there are four in existence:

* Meilisearch (preferred)
* Elasticsearch (deprecated, only supports LMS search functionalities, not Studio)
* Typesense (beta/provisional support, only supports LMS search functionalities, not Studio)
* MockSearchEngine (primarily used for testing)

To operate with the currently-specified SearchEngine from the django settings, one can invoke a static method on SearchEngine as follows:
```
Expand Down
Loading