Update README.md (#105)

Author: curquiza

README.md

@@ -6,10 +6,10 @@
 
 <h4 align="center">
   <a href="https://github.com/meilisearch/MeiliSearch">MeiliSearch</a> |
+  <a href="https://docs.meilisearch.com">Documentation</a> |
   <a href="https://www.meilisearch.com">Website</a> |
   <a href="https://blog.meilisearch.com">Blog</a> |
   <a href="https://twitter.com/meilisearch">Twitter</a> |
-  <a href="https://docs.meilisearch.com">Documentation</a> |
   <a href="https://docs.meilisearch.com/faq">FAQ</a>
 </h4>
 
@@ -20,18 +20,23 @@
   <a href="https://slack.meilisearch.com"><img src="https://img.shields.io/badge/slack-MeiliSearch-blue.svg?logo=slack" alt="Slack"></a>
 </p>
 
-<p align="center">⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Ruby 💎</p>
+<p align="center">⚡ The MeiliSearch API client written for Ruby 💎</p>
 
-**MeiliSearch Ruby** is a client for **MeiliSearch** written in Ruby. **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.
+**MeiliSearch Ruby** is the MeiliSearch API client for Ruby 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.
 
 ## Table of Contents <!-- omit in toc -->
 
+- [📖 Documentation](#-documentation)
 - [🔧 Installation](#-installation)
-- [🚀 Getting started](#-getting-started)
+- [🚀 Getting Started](#-getting-started)
 - [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch)
-- [📖 Documentation and Examples](#-documentation-and-examples)
+- [� Learn More](#-learn-more)
 - [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing)
 
+## 📖 Documentation
+
+See our [Documentation](https://docs.meilisearch.com/guides/introduction/quick_start_guide.html) or our [API References](https://docs.meilisearch.com/references/).
+
 ## 🔧 Installation
 
 With `gem` in command line:
@@ -51,14 +56,15 @@ gem 'meilisearch'
 There are many easy ways to [download and run a MeiliSearch instance](https://docs.meilisearch.com/guides/advanced_guides/installation.html#download-and-launch).
 
 For example, if you use Docker:
+
 ```bash
 $ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
 $ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey
 ```
 
 NB: you can also download MeiliSearch from **Homebrew** or **APT**.
 
-## 🚀 Getting started
+## 🚀 Getting Started
 
 #### Add documents <!-- omit in toc -->
 
@@ -80,7 +86,7 @@ documents = [
 index.add_documents(documents) # => { "updateId": 0 }
 ```
 
-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).
+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).
 
 #### Basic Search <!-- omit in toc -->
 
@@ -89,6 +95,7 @@ With the `updateId`, you can check the status (`processed` or `failed`) of your
 puts index.search('harry pottre')
 ```
 Output:
+
 ```ruby
 {
   "hits" => [{
@@ -107,9 +114,16 @@ Output:
 All the supported options are described in the [search parameters](https://docs.meilisearch.com/guides/advanced_guides/search_parameters.html) section of the documentation.
 
 ```ruby
-index.search('prince', { limit: 1, attributesToHighlight: '*' })
+index.search('prince',
+  {
+    filters: 'book_id > 10',
+    attributesToHighlight: ['*']
+  }
+)
 ```
 
+JSON output:
+
 ```json
 {
     "hits": [
@@ -123,7 +137,7 @@ index.search('prince', { limit: 1, attributesToHighlight: '*' })
         }
     ],
     "offset": 0,
-    "limit": 1,
+    "limit": 20,
     "processingTimeMs": 0,
     "query": "prince"
 }
@@ -133,18 +147,14 @@ index.search('prince', { limit: 1, attributesToHighlight: '*' })
 
 This package only guarantees the compatibility with the [version v0.15.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.15.0).
 
-## 📖 Documentation and Examples
-
-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**.
-
-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!
+## 💡 Learn More
 
 The following sections may interest you:
 
-- [Manipulate documents](https://docs.meilisearch.com/references/documents.html)
-- [Search](https://docs.meilisearch.com/references/search.html)
-- [Manage the indexes](https://docs.meilisearch.com/references/indexes.html)
-- [Configure the index settings](https://docs.meilisearch.com/references/settings.html)
+- **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).
+- **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).
+- **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).
+- **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).
 
 ## ⚙️ Development Workflow and Contributing