From bc502ee125b609639146828f2ab8878056900bca Mon Sep 17 00:00:00 2001 From: Anirudh Rowjee Date: Mon, 3 Oct 2022 09:38:59 +0530 Subject: [PATCH 1/2] [docs] Fixed #652, changes spelling of author --- README.md | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index d69c43656..b76252622 100644 --- a/README.md +++ b/README.md @@ -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. 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. - - The `filter-parser` crate contains the parser for the Meilisearch filter syntax. - - 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. + +- 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. +- The `filter-parser` crate contains the parser for the Meilisearch filter syntax. +- 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? @@ -39,28 +40,28 @@ let content = documents!([ { "id": 2, "title": "Prideand Prejudice", - "au{hor": "Jane Austin", + "author": "Jane Austin", "genre": "romance", "price$": "3.5$", }, { "id": 456, "title": "Le Petit Prince", - "au{hor": "Antoine de Saint-Exupéry", + "author": "Antoine de Saint-Exupéry", "genre": "adventure", "price$": "10.0$", }, { "id": 1, "title": "Wonderland", - "au{hor": "Lewis Carroll", + "author": "Lewis Carroll", "genre": "fantasy", "price$": "25.99$", }, { "id": 4, "title": "Harry Potter ing fantasy\0lood Prince", - "au{hor": "J. K. Rowling", + "author": "J. K. Rowling", "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. -[Meilisearch]: https://github.com/meilisearch/meilisearch +[meilisearch]: https://github.com/meilisearch/meilisearch [flamegraph]: https://github.com/flamegraph-rs/flamegraph From 7d247353d003d7226cab970b537cfc5abb36d475 Mon Sep 17 00:00:00 2001 From: Anirudh Rowjee Date: Mon, 3 Oct 2022 09:52:20 +0530 Subject: [PATCH 2/2] [docs] contd - fix #652, revert capitalization of 'Meilisearch' --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b76252622..378751a3f 100644 --- a/README.md +++ b/README.md @@ -92,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. -[meilisearch]: https://github.com/meilisearch/meilisearch +[Meilisearch]: https://github.com/meilisearch/meilisearch [flamegraph]: https://github.com/flamegraph-rs/flamegraph