Add installation changes

Author: Strift

README.tpl

@@ -35,7 +35,6 @@
 ## Table of Contents <!-- omit in TOC -->
 
 - [📖 Documentation](#-documentation)
-- [⚡ Supercharge your Meilisearch experience](#-supercharge-your-meilisearch-experience)
 - [🔧 Installation](#-installation)
 - [🚀 Getting started](#-getting-started)
 - [🌐 Running in the Browser with WASM](#-running-in-the-browser-with-wasm)
@@ -48,10 +47,6 @@ This readme contains all the documentation you need to start using this Meilisea
 
 For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our [main documentation website](https://www.meilisearch.com/docs).
 
-## ⚡ Supercharge your Meilisearch experience
-
-Say goodbye to server deployment and manual updates with [Meilisearch Cloud](https://www.meilisearch.com/cloud?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust). Get started with a 14-day free trial! No credit card required.
-
 ## 🔧 Installation
 
 To use `meilisearch-sdk`, add this to your `Cargo.toml`:
@@ -73,25 +68,170 @@ You can enable the `sync` feature to make most structs `Sync`. It may be a bit s
 
 Using this crate is possible without [serde](https://crates.io/crates/serde), but a lot of features require serde.
 
-### Run a Meilisearch Instance <!-- omit in TOC -->
+### Run Meilisearch <!-- omit in toc -->
+
+⚡️ **Launch, scale, and streamline in minutes with Meilisearch Cloud**—no maintenance, no commitment, cancel anytime. [Try it free now](https://cloud.meilisearch.com/login?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust).
+
+🪨  Prefer to self-host? [Download and deploy](https://www.meilisearch.com/docs/learn/self_hosted/getting_started_with_self_hosted_meilisearch?utm_campaign=oss&utm_source=github&utm_medium=meilisearch-rust) our fast, open-source search engine on your own infrastructure.
+
+## 🚀 Getting started
 
-This crate requires a Meilisearch server to run.
+#### Add Documents <!-- omit in TOC -->
 
-There are many easy ways to [download and run a Meilisearch instance](https://www.meilisearch.com/docs/learn/getting_started/installation).
+```rust
+use meilisearch_sdk::client::*;
+use serde::{Serialize, Deserialize};
+use futures::executor::block_on;
 
-For example,using the `curl` command in [your Terminal](https://itconnect.uw.edu/learn/workshops/online-tutorials/web-publishing/what-is-a-terminal/):
+#[derive(Serialize, Deserialize, Debug)]
+struct Movie {
+    id: usize,
+    title: String,
+    genres: Vec<String>,
+}
 
-```bash
-# Install Meilisearch
-curl -L https://install.meilisearch.com | sh
 
-# Launch Meilisearch
-./meilisearch --master-key=masterKey
+#[tokio::main(flavor = "current_thread")]
+async fn main() {
+    // Create a client (without sending any request so that can't fail)
+    let client = Client::new(MEILISEARCH_URL, Some(MEILISEARCH_API_KEY)).unwrap();
+
+    // An index is where the documents are stored.
+    let movies = client.index("movies");
+
+    // Add some movies in the index. If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
+    movies.add_documents(&[
+        Movie { id: 1, title: String::from("Carol"), genres: vec!["Romance".to_string(), "Drama".to_string()] },
+        Movie { id: 2, title: String::from("Wonder Woman"), genres: vec!["Action".to_string(), "Adventure".to_string()] },
+        Movie { id: 3, title: String::from("Life of Pi"), genres: vec!["Adventure".to_string(), "Drama".to_string()] },
+        Movie { id: 4, title: String::from("Mad Max"), genres: vec!["Adventure".to_string(), "Science Fiction".to_string()] },
+        Movie { id: 5, title: String::from("Moana"), genres: vec!["Fantasy".to_string(), "Action".to_string()] },
+        Movie { id: 6, title: String::from("Philadelphia"), genres: vec!["Drama".to_string()] },
+    ], Some("id")).await.unwrap();
+}
 ```
 
-NB: you can also download Meilisearch from **Homebrew** or **APT**.
+With the `uid`, you can check the status (`enqueued`, `canceled`, `processing`, `succeeded` or `failed`) of your documents addition using the [task](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
+
+#### Basic Search <!-- omit in TOC -->
+
+```rust
+// Meilisearch is typo-tolerant:
+println!("{:?}", client.index("movies_2").search().with_query("caorl").execute::<Movie>().await.unwrap().hits);
+```
+
+Output:
+```
+[Movie { id: 1, title: String::from("Carol"), genres: vec!["Romance", "Drama"] }]
+```
+
+Json output:
+```json
+{
+  "hits": [{
+    "id": 1,
+    "title": "Carol",
+    "genres": ["Romance", "Drama"]
+  }],
+  "offset": 0,
+  "limit": 10,
+  "processingTimeMs": 1,
+  "query": "caorl"
+}
+```
+
+#### Custom Search <!-- omit in toc -->
+
+```rust
+let search_result = client.index("movies_3")
+  .search()
+  .with_query("phil")
+  .with_attributes_to_highlight(Selectors::Some(&["*"]))
+  .execute::<Movie>()
+  .await
+  .unwrap();
+println!("{:?}", search_result.hits);
+```
+
+Json output:
+```json
+{
+    "hits": [
+        {
+            "id": 6,
+            "title": "Philadelphia",
+            "_formatted": {
+                "id": 6,
+                "title": "<em>Phil</em>adelphia",
+                "genre": ["Drama"]
+            }
+        }
+    ],
+    "offset": 0,
+    "limit": 20,
+    "processingTimeMs": 0,
+    "query": "phil"
+}
+```
+
+#### Custom Search With Filters <!-- omit in TOC -->
+
+If you want to enable filtering, you must add your attributes to the `filterableAttributes`
+index setting.
+
+```rust
+let filterable_attributes = [
+    "id",
+    "genres",
+];
+client.index("movies_4").set_filterable_attributes(&filterable_attributes).await.unwrap();
+```
+
+You only need to perform this operation once.
+
+Note that Meilisearch will rebuild your index whenever you update `filterableAttributes`. Depending on the size of your dataset, this might take time. You can track the process using the [tasks](https://www.meilisearch.com/docs/reference/api/tasks#get-task).
+
+Then, you can perform the search:
+
+```rust
+let search_result = client.index("movies_5")
+  .search()
+  .with_query("wonder")
+  .with_filter("id > 1 AND genres = Action")
+  .execute::<Movie>()
+  .await
+  .unwrap();
+println!("{:?}", search_result.hits);
+```
+
+Json output:
+```json
+{
+  "hits": [
+    {
+      "id": 2,
+      "title": "Wonder Woman",
+      "genres": ["Action", "Adventure"]
+    }
+  ],
+  "offset": 0,
+  "limit": 20,
+  "estimatedTotalHits": 1,
+  "processingTimeMs": 0,
+  "query": "wonder"
+}
+```
+
+#### Customize the `HttpClient` <!-- omit in TOC -->
+
+By default, the SDK uses [`reqwest`](https://docs.rs/reqwest/latest/reqwest/) to make http calls.
+The SDK lets you customize the http client by implementing the `HttpClient` trait yourself and
+initializing the `Client` with the `new_with_client` method.
+You may be interested by the `futures-unsend` feature which lets you specify a non-Send http client.
+
+#### Wasm support <!-- omit in TOC -->
 
-{{readme}}
+The SDK supports wasm through reqwest. You'll need to enable the `futures-unsend` feature while importing it, though.
 
 ## 🌐 Running in the Browser with WASM <!-- omit in TOC -->