Skip to content
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

Jump to bottom

docs: adds orama video to homepage #382

Merged
merged 1 commit into from
May 19, 2023
Merged

docs: adds orama video to homepage #382

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 14 additions & 3 deletions packages/docs/pages/index.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,18 @@ import { AiFillFileAdd, AiOutlineSearch, AiFillDelete } from 'react-icons/ai'

# Getting Started with Orama

Orama is an **immutable, runtime-agnostic, edge, and in-memory full-text search engine** that works both on client and server.

Through implementing an optimized prefix tree and some clever tweaks, Orama can perform searches through millions of entries in **microseconds**.
Orama is a fast, batteries-included, full-text search engine entirely written in TypeScript, with zero dependencies. <br /><br />

<iframe
width="100%"
height="420"
src="https://www.youtube.com/embed/5CN65esOz-Y"
title="YouTube video player"
frameBorder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
allowfullscreen>
</iframe>
<br />

Get started with just a few lines of code:

Expand Down Expand Up @@ -43,6 +52,8 @@ Get started with just a few lines of code:
/>
</Cards>



## Requirements

A JavaScript runtime is the **only** requirement. Orama has been designed to work on any runtime and has no dependencies.
Expand Down