Skip to content

Commit b95c047

Browse files
authored
Update README.md (#60)
1 parent 3e608c6 commit b95c047

File tree

2 files changed

+18
-6
lines changed

2 files changed

+18
-6
lines changed

README.md

+9-3
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010

1111
<h4 align="center">
1212
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
13+
<a href="https://docs.meilisearch.com">Documentation</a> |
1314
<a href="https://www.meilisearch.com">Website</a> |
1415
<a href="https://blog.meilisearch.com">Blog</a> |
1516
<a href="https://twitter.com/meilisearch">Twitter</a> |
16-
<a href="https://docs.meilisearch.com">Documentation</a> |
1717
<a href="https://docs.meilisearch.com/faq">FAQ</a>
1818
</h4>
1919

@@ -23,20 +23,26 @@
2323
<a href="https://github.com/meilisearch/meilisearch-rust/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
2424
<a href="https://github.com/meilisearch/MeiliSearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
2525
<a href="https://slack.meilisearch.com"><img src="https://img.shields.io/badge/slack-MeiliSearch-blue.svg?logo=slack" alt="Slack"></a>
26+
<a href="https://app.bors.tech/repositories/28502"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2627
</p>
2728

28-
<p align="center">⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Rust</p>
29+
<p align="center">⚡ The MeiliSearch API client written for Rust 🦀</p>
2930

30-
**MeiliSearch Rust** is a client for **MeiliSearch** written in Rust. **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.
31+
**MeiliSearch Rust** is the MeiliSearch API client for Rust 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.
3132

3233
## Table of Contents
3334

35+
- [📖 Documentation](#-documentation)
3436
- [🔧 Installation](#-installation)
3537
- [🚀 Getting Started](#-getting-started)
3638
- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
3739
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
3840
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
3941

42+
## 📖 Documentation
43+
44+
See our [Documentation](https://docs.meilisearch.com/guides/introduction/quick_start_guide.html) or our [API References](https://docs.meilisearch.com/references/).
45+
4046
## 🔧 Installation
4147

4248
To use `meilisearch-sdk`, add this to your `Cargo.toml`:

README.tpl

+9-3
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@
1010

1111
<h4 align="center">
1212
<a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
13+
<a href="https://docs.meilisearch.com">Documentation</a> |
1314
<a href="https://www.meilisearch.com">Website</a> |
1415
<a href="https://blog.meilisearch.com">Blog</a> |
1516
<a href="https://twitter.com/meilisearch">Twitter</a> |
16-
<a href="https://docs.meilisearch.com">Documentation</a> |
1717
<a href="https://docs.meilisearch.com/faq">FAQ</a>
1818
</h4>
1919

@@ -23,20 +23,26 @@
2323
<a href="https://github.com/meilisearch/meilisearch-rust/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-informational" alt="License"></a>
2424
<a href="https://github.com/meilisearch/MeiliSearch/discussions" alt="Discussions"><img src="https://img.shields.io/badge/github-discussions-red" /></a>
2525
<a href="https://slack.meilisearch.com"><img src="https://img.shields.io/badge/slack-MeiliSearch-blue.svg?logo=slack" alt="Slack"></a>
26+
<a href="https://app.bors.tech/repositories/28502"><img src="https://bors.tech/images/badge_small.svg" alt="Bors enabled"></a>
2627
</p>
2728

28-
<p align="center">⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Rust</p>
29+
<p align="center">⚡ The MeiliSearch API client written for Rust 🦀</p>
2930

30-
**MeiliSearch Rust** is a client for **MeiliSearch** written in Rust. **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.
31+
**MeiliSearch Rust** is the MeiliSearch API client for Rust 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.
3132

3233
## Table of Contents
3334

35+
- [📖 Documentation](#-documentation)
3436
- [🔧 Installation](#-installation)
3537
- [🚀 Getting Started](#-getting-started)
3638
- [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
3739
- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
3840
- [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
3941

42+
## 📖 Documentation
43+
44+
See our [Documentation](https://docs.meilisearch.com/guides/introduction/quick_start_guide.html) or our [API References](https://docs.meilisearch.com/references/).
45+
4046
{{readme}}
4147

4248
## 🤖 Compatibility with MeiliSearch

0 commit comments

Comments
 (0)