Skip to content

Commit 40e356a

Browse files
authored
Update README.md (#164)
1 parent 507ce1c commit 40e356a

File tree

1 file changed

+22
-17
lines changed

1 file changed

+22
-17
lines changed

README.md

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@
66

77
<h4 align="center">
88
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
9+
<a href="https://docs.meilisearch.com">Documentation</a> |
910
<a href="https://www.meilisearch.com">Website</a> |
1011
<a href="https://blog.meilisearch.com">Blog</a> |
1112
<a href="https://twitter.com/meilisearch">Twitter</a> |
12-
<a href="https://docs.meilisearch.com">Documentation</a> |
1313
<a href="https://docs.meilisearch.com/faq">FAQ</a>
1414
</h4>
1515

@@ -20,18 +20,23 @@
2020
<a href="https://slack.meilisearch.com"><img src="https://img.shields.io/badge/slack-MeiliSearch-blue.svg?logo=slack" alt="Slack"></a>
2121
</p>
2222

23-
<p align="center">⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Python</p>
23+
<p align="center">⚡ The MeiliSearch API client written for Python 🐍</p>
2424

25-
**MeiliSearch Python** is a client for **MeiliSearch** written in Python. **MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
25+
**MeiliSearch Python** is the MeiliSearch API client for Python developers. **MeiliSearch** is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, facets, and synonyms are provided out-of-the-box.
2626

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

29+
- [📖 Documentation](#-documentation)
2930
- [🔧 Installation](#-installation)
3031
- [🚀 Getting started](#-getting-started)
3132
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
32-
- [📖 Documentation and Examples](#-documentation-and-examples)
33+
- [� Learn More](#-learn-more)
3334
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
3435

36+
## 📖 Documentation
37+
38+
See our [Documentation](https://docs.meilisearch.com/guides/introduction/quick_start_guide.html) or our [API References](https://docs.meilisearch.com/references/).
39+
3540
## 🔧 Installation
3641

3742
With `pip3` in command line:
@@ -45,6 +50,7 @@ $ pip3 install meilisearch
4550
There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/guides/advanced_guides/installation.html#download-and-launch).
4651

4752
For example, if you use Docker:
53+
4854
```bash
4955
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
5056
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
@@ -75,7 +81,7 @@ documents = [
7581
index.add_documents(documents) # => { "updateId": 0 }
7682
```
7783

78-
With the `updateId`, you can check the status (`processed` or `failed`) of your documents addition thanks to this [method](https://docs.meilisearch.com/references/updates.html#get-an-update-status).
84+
With the `updateId`, you can check the status (`enqueued`, `processed` or `failed`) of your documents addition using the [update endpoint](https://docs.meilisearch.com/references/updates.html#get-an-update-status).
7985

8086
#### Basic Search <!-- omit in toc -->
8187

@@ -85,6 +91,7 @@ index.search('harry pottre')
8591
```
8692

8793
Output:
94+
8895
```python
8996
{
9097
"hits" => [{
@@ -106,12 +113,14 @@ All the supported options are described in the [search parameters](https://docs.
106113
index.search(
107114
'prince',
108115
{
109-
'limit': 1,
110-
'attributesToHighlight': ['title']
116+
'attributesToHighlight': ['title'],
117+
'filters': ['book_id > 10']
111118
}
112119
)
113120
```
114121

122+
JSON output:
123+
115124
```json
116125
{
117126
"hits": [
@@ -125,7 +134,7 @@ index.search(
125134
}
126135
],
127136
"offset": 0,
128-
"limit": 1,
137+
"limit": 20,
129138
"processingTimeMs": 10,
130139
"query": "prince"
131140
}
@@ -135,18 +144,14 @@ index.search(
135144

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

138-
## 📖 Documentation and Examples
139-
140-
MeiliSearch documentation provides **examples** and a detailed explanation of every one of its features and functionalities, including examples on how to implement them **using this SDK**.
141-
142-
Please read the [guides available in the documentation](https://docs.meilisearch.com/guides/) or check the [API references](https://docs.meilisearch.com/references/) to find the one that you need!
147+
## 💡 Learn More
143148

144149
The following sections may interest you:
145150

146-
- [Manipulate documents](https://docs.meilisearch.com/references/documents.html)
147-
- [Search](https://docs.meilisearch.com/references/search.html)
148-
- [Manage the indexes](https://docs.meilisearch.com/references/indexes.html)
149-
- [Configure the index settings](https://docs.meilisearch.com/references/settings.html)
151+
- **Manipulate documents**: see the [API references](https://docs.meilisearch.com/references/documents.html) or read more about [documents](https://docs.meilisearch.com/guides/main_concepts/documents.html).
152+
- **Search**: see the [API references](https://docs.meilisearch.com/references/search.html) or follow our guide on [search parameters](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html).
153+
- **Manage the indexes**: see the [API references](https://docs.meilisearch.com/references/indexes.html) or read more about [indexes](https://docs.meilisearch.com/guides/main_concepts/indexes.html).
154+
- **Configure the index settings**: see the [API references](https://docs.meilisearch.com/references/settings.html) or follow our guide on [settings parameters](https://docs.meilisearch.com/guides/advanced_guides/settings.html).
150155

151156
## ⚙️ Development Workflow and Contributing
152157

0 commit comments

Comments
 (0)