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

Added name explanation in README #104

Closed
wants to merge 3 commits into from
Closed

Added name explanation in README #104

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e25b0f
Added name explanation in README
Mount-Blanc May 19, 2022
38c62c1
Rewrote name explanation
Mount-Blanc May 28, 2022
6f4fd2f
Merge branch 'meilisearch:main' into docs/102-README
Mount-Blanc May 28, 2022
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
6 changes: 5 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Charabia
Library used by Meilisearch to tokenize queries and documents
We choose the name of this repository because it starts with char which was done in the same mood as discord or meili, giving the name of the problem we want to solve.
Personally, I don’t feel like it’s an offensive word, but more a funny pun with “char”.
Moreover, other tokenizers don’t always have an understandable name, for instance [lindera](https://github.com/lindera-morphology/lindera) maintained by [@minoru_osuka](https://twitter.com/minoru_osuka) or even [jieba](https://github.com/messense/jieba-rs).
I hope my explanation was clear enough and I hope the name will not discourage you to use or even contribute to the project! 😊

## Role

Expand Down Expand Up @@ -71,4 +75,4 @@ let mut segments = orig.segment_str();
assert_eq!(segments.next(), Some("The"));
assert_eq!(segments.next(), Some(" "));
assert_eq!(segments.next(), Some("quick"));
```
```