Skip to content

Commit f8a3ee7

Browse files
authored
Update README (#50)
1 parent c7ee6f9 commit f8a3ee7

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,38 @@
2828

2929
## Table of Contents <!-- omit in toc -->
3030

31-
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
32-
- [✨ Features](#-features)
3331
- [📖 Documentation](#-documentation)
32+
- [📝 Requirements](#-requirements)
33+
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
34+
- [💡 Learn More](#-learn-more)
3435
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
3536

36-
## 🤖 Compatibility with MeiliSearch
37+
## 📖 Documentation
3738

38-
This package only guarantees the compatibility with the [version v0.18.1 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.18.1).
39+
Check out the [Uncyclo](https://github.com/meilisearch/meilisearch-symfony/wiki) of this repository to get started! 🚀
40+
41+
Also, see our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).
3942

40-
## ✨ Features
43+
## 📝 Requirements
4144

4245
* **Require** PHP 7.2 and later.
4346
* **Compatible** with Symfony 4.0 and later.
4447
* **Support** Doctrine ORM and Doctrine MongoDB.
4548

46-
## 📖 Documentation
49+
## 🤖 Compatibility with MeiliSearch
50+
51+
This package only guarantees the compatibility with the [version v0.18.1 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.18.1).
52+
53+
## 💡 Learn More
54+
55+
The following sections may interest you:
4756

48-
Complete documentation of the MeiliSearch Bundle is available in the [Uncyclo section](https://github.com/meilisearch/meilisearch-symfony/wiki).
57+
- **Manipulate documents**: see the [API references](https://docs.meilisearch.com/reference/api/documents.html) or read more about [documents](https://docs.meilisearch.com/learn/core_concepts/documents.html).
58+
- **Search**: see the [API references](https://docs.meilisearch.com/reference/api/search.html) or follow our guide on [search parameters](https://docs.meilisearch.com/reference/features/search_parameters.html).
59+
- **Manage the indexes**: see the [API references](https://docs.meilisearch.com/reference/api/indexes.html) or read more about [indexes](https://docs.meilisearch.com/learn/core_concepts/indexes.html).
60+
- **Configure the index settings**: see the [API references](https://docs.meilisearch.com/reference/api/settings.html) or follow our guide on [settings parameters](https://docs.meilisearch.com/reference/features/settings.html).
4961

50-
You can also check out the [MeiliSearch documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html).
62+
📖 Also, check out the [Uncyclo](https://github.com/meilisearch/meilisearch-symfony/wiki) of this repository!
5163

5264
## ⚙️ Development Workflow and Contributing
5365

0 commit comments

Comments
 (0)