Refactor README

[flevi29]

Pull Request

What does this PR do?

• remove tons of unnecessary bloat from the README.md, keep and refactor only what matters
  • remove table of contents, GitHub already provides its own table of contents and the README is so short now that it's no longer requried
  • replace "Getting started" with "Example code" and link to the playground instead of hardcoding some examples
    • examples can easily get out of date, hard to keep track of, when kept in a README
    • many of the examples have little to do with this library, but rather present the capabilities of Meilisearch
  • remove information on ways of importing the package, it can be imported in all the standard ways possible, it is not our responsibility to inform people on how to import packages
  • remove "Learn more" section, the main documentation page link should suffice
  • remove "API resources" section, typedoc already does a way better job at documenting the API, which is linked in the "Documentation" section
• add note about TypeScript support regarding generateTenantToken not available #1838

PR checklist

Please check if your PR fulfills the following requirements:

• Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
• Have you read the contributing guidelines?
• Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

todo: open issue about formatting everything that can be formatted with prettier

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.84%. Comparing base (792ce67) to head (a26a17d).

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1836   +/-   ##
=======================================
  Coverage   98.84%   98.84%           
=======================================
  Files          17       17           
  Lines        1565     1565           
  Branches      338      338           
=======================================
  Hits         1547     1547           
  Misses         18       18           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Strift]

There are some strict guidelines regarding Meilisearch README that prevent me from reviewing this PR quickly.

If you can make a separate PR for the playground updates, I could review it faster. Thanks!

[flevi29]

Okay I'll separate that.

[Strift]

Hi @flevi29, thanks for your contribution.

Meilisearch uses automated scripts to update the README.md across all their integrations.

For now, I cannot allow the structure of this README to change, because it would affect our ability to batch update all repositories. Unfortunately, I can't prioritize working on this over the other tasks related to the v1.13 release.

However, I opened an issue to track #1843 separately. I think that's the most important part of the PR for now, and I will review and merge ASAP.

For the rest, we will have to revisit in the future. 🙏