Skip to content

Commit

Permalink
docs: updates readme
Browse files Browse the repository at this point in the history
  • Loading branch information
micheleriva authored May 8, 2023
1 parent aabf555 commit 0202a66
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,14 @@ If you need more info, help, or want to provide general feedback on Orama, join
the
[Orama Slack channel](https://join.slack.com/t/orama-community/shared_invite/zt-1gzvj0mmt-yJhJ6pnrSGuwqPmPx9uO5Q)

# Highlighted features
- [Search filters](https://docs.oramasearch.com/usage/search/filters)
- [Facets](https://docs.oramasearch.com/usage/search/facets)
- [Fields Boosting](https://docs.oramasearch.com/usage/search/fields-boosting)
- [Typo tolerance](https://docs.oramasearch.com/usage/search/introduction#typo-tolerance)
- [Exact match](https://docs.oramasearch.com/usage/search/introduction#exact-match)
- [Stemming and tokenizing in 26 languages](https://docs.oramasearch.com/text-analysis/stemming)

# Installation

You can install Orama using `npm`, `yarn`, `pnpm`:
Expand Down Expand Up @@ -222,7 +230,9 @@ create(/* ... */)
Note that only main methods are supported so for internals and other supported exports you still have to use `await import`.
# Filters
# Highlighted features
### Filters
<details>
<summary>
Expand Down Expand Up @@ -282,7 +292,7 @@ Learn more about filters in the [official filters docs](https://docs.oramasearch
</details>
# Facets
### Facets
<details>
<summary>
Expand Down Expand Up @@ -388,7 +398,7 @@ Learn more about facets in the [official facets docs](https://docs.oramasearch.c
</details>
# Fields boosting
### Fields boosting
<details>
<summary>
Expand Down

0 comments on commit 0202a66

Please sign in to comment.