Skip to content

Update README #50

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 6, 2021
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 20 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,38 @@

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

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

## 🤖 Compatibility with MeiliSearch
## 📖 Documentation

This package only guarantees the compatibility with the [version v0.18.1 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.18.1).
Check out the [Uncyclo](https://github.com/meilisearch/meilisearch-symfony/wiki) of this repository to get started! 🚀

Also, see our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_started.html) or our [API References](https://docs.meilisearch.com/reference/api/).

## ✨ Features
## 📝 Requirements

* **Require** PHP 7.2 and later.
* **Compatible** with Symfony 4.0 and later.
* **Support** Doctrine ORM and Doctrine MongoDB.

## 📖 Documentation
## 🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the [version v0.18.1 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.18.1).

## 💡 Learn More

The following sections may interest you:

Complete documentation of the MeiliSearch Bundle is available in the [Uncyclo section](https://github.com/meilisearch/meilisearch-symfony/wiki).
- **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).
- **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).
- **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).
- **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).

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

## ⚙️ Development Workflow and Contributing

Expand Down