[docs] Fixed #652, changes spelling of author

This commit is contained in:
Anirudh Rowjee 2022-10-03 09:38:59 +05:30
parent 804db03e41
commit bc502ee125

View File

@ -14,11 +14,12 @@ it is the job of something else above and this is why it is only able
to process one update at a time. to process one update at a time.
This repository contains crates to quickly debug the engine: This repository contains crates to quickly debug the engine:
- There are benchmarks located in the `benchmarks` crate.
- The `cli` crate is a simple command-line interface that helps run [flamegraph] on top of it. - There are benchmarks located in the `benchmarks` crate.
- The `filter-parser` crate contains the parser for the Meilisearch filter syntax. - The `cli` crate is a simple command-line interface that helps run [flamegraph] on top of it.
- The `flatten-serde-json` crate contains the library that flattens serde-json `Value` objects like Elasticsearch does. - The `filter-parser` crate contains the parser for the Meilisearch filter syntax.
- The `json-depth-checker` crate is used to indicate if a JSON must be flattened. - The `flatten-serde-json` crate contains the library that flattens serde-json `Value` objects like Elasticsearch does.
- The `json-depth-checker` crate is used to indicate if a JSON must be flattened.
## How to use it? ## How to use it?
@ -39,28 +40,28 @@ let content = documents!([
{ {
"id": 2, "id": 2,
"title": "Prideand Prejudice", "title": "Prideand Prejudice",
"au{hor": "Jane Austin", "author": "Jane Austin",
"genre": "romance", "genre": "romance",
"price$": "3.5$", "price$": "3.5$",
}, },
{ {
"id": 456, "id": 456,
"title": "Le Petit Prince", "title": "Le Petit Prince",
"au{hor": "Antoine de Saint-Exupéry", "author": "Antoine de Saint-Exupéry",
"genre": "adventure", "genre": "adventure",
"price$": "10.0$", "price$": "10.0$",
}, },
{ {
"id": 1, "id": 1,
"title": "Wonderland", "title": "Wonderland",
"au{hor": "Lewis Carroll", "author": "Lewis Carroll",
"genre": "fantasy", "genre": "fantasy",
"price$": "25.99$", "price$": "25.99$",
}, },
{ {
"id": 4, "id": 4,
"title": "Harry Potter ing fantasy\0lood Prince", "title": "Harry Potter ing fantasy\0lood Prince",
"au{hor": "J. K. Rowling", "author": "J. K. Rowling",
"genre": "fantasy\0", "genre": "fantasy\0",
}, },
]); ]);
@ -91,5 +92,5 @@ We're glad you're thinking about contributing to this repository! Feel free to p
Also, we recommend following the [CONTRIBUTING.md](/CONTRIBUTING.md) to create your PR. Also, we recommend following the [CONTRIBUTING.md](/CONTRIBUTING.md) to create your PR.
[Meilisearch]: https://github.com/meilisearch/meilisearch [meilisearch]: https://github.com/meilisearch/meilisearch
[flamegraph]: https://github.com/flamegraph-rs/flamegraph [flamegraph]: https://github.com/flamegraph-rs/flamegraph