Add more documentations

[curquiza]

This tool is not obvious to use and our users need more documentation about how to use Instant Search + instant-meilisearch. The sandbox is not enough.

Two steps:

1. Find a place for this kind of "tutorials": a examples folder? A longer README?
2. Write them

Here is a non-exhaustive list of the step 2:

• How to crop a field
• How to sort the facets (https://www.algolia.com/doc/api-reference/widgets/refinement-list/js/#widget-param-sortby). See also: sort the facets by value #149.
• How to remove the zero facets count (https://www.algolia.com/doc/api-reference/widgets/refinement-list/js/#widget-param-transformitems). See: Codesandbox demo is freezing meilisearch-react#5 (comment)
• How to customize pagination (hits per page, number max of hits, number max of pages...)

⚠️ the meilisearch-react and meilisearch-vue demo might need the same docs! But let's start with this repo first.

[bidoubiwa]

• How to crop a field is fixed by Add compatibility with instantsearch types #530
• How to sort the facets: See issue Add documentation on how to sort facets  #544
• How to remove the zero facets count fixed by MeiliSearch, exception for the checked facets with a count of 0. They always appear see Add cache on facets distribution #458
• How to customize pagination, is this documentation enough or should we add more ?

[bidoubiwa]

@curquiza do you think more documentation is required?

[curquiza]

It's ok for me, but you are better than me now to say if it's enough or not 😊

[bidoubiwa]

I think it is enough, I hope so at least. Im closing this issue