Merge #117

117: Remove dollar signs from code examples r=curquiza a=sanders41

Relates to meilisearch/integration-guides#99
Relates to meilisearch/integration-guides#103

Co-authored-by: Paul Sanders <psanders1@gmail.com>

Author: bors[bot]

.gitignore

@@ -1,3 +1,4 @@
 /target
 Cargo.lock
 examples/web_app/target/*
+.vscode

CONTRIBUTING.md

@@ -39,9 +39,9 @@ To run the tests one by one, run:
 
 ```bash
 # Tests
-$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
-$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
-$ cargo test -- --test-threads=1
+docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
+docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
+cargo test -- --test-threads=1
 ```
 
 Each PR should pass the tests to be accepted.
@@ -51,20 +51,20 @@ Each PR should pass the tests to be accepted.
 Each PR should pass [`clippy`](https://github.com/rust-lang/rust-clippy) (the linter) to be accepted.
 
 ```bash
-$ cargo clippy -- -D warnings
+cargo clippy -- -D warnings
 ```
 
 If you don't have `clippy` installed on your machine yet, run:
 
 ```bash
-$ rustup update
-$ rustup component add clippy
+rustup update
+rustup component add clippy
 ```
 
 ⚠️ Also, if you have installed `clippy` a long time ago, you might need to update it:
 
 ```bash
-$ rustup update
+rustup update
 ```
 
 ### Update the README
@@ -74,17 +74,17 @@ The README is generated. Please do not update manually the `README.md` file.
 Instead, update the `README.tpl` and `src/lib.rs` files, and run:
 
 ```sh
-$ sh scripts/update-readme.sh
+sh scripts/update-readme.sh
 ```
 
 Then, add the generated `README.md` file to your git commit.
 
 You can check the current `README.md` is up-to-date by running:
 
 ```sh
-$ sh scripts/check-readme.sh
+sh scripts/check-readme.sh
 # To see the diff
-$ sh scripts/check-readme.sh --diff
+sh scripts/check-readme.sh --diff
 ```
 
 If it's not, the CI will fail on your PR.
@@ -151,7 +151,7 @@ with the right version.
 You should run the following command after the changes applied to `lib.rs`:
 
 ```bash
-$ sh scripts/update-readme.sh
+sh scripts/update-readme.sh
 ```
 
 Also, you might need to change the [code-samples file](/.code-samples.meilisearch.yaml) if the minor has been upgraded:

README.md

@@ -71,8 +71,8 @@ There are many easy ways to [download and run a MeiliSearch instance](https://do
 
 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
+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**.

examples/web_app/README.md

@@ -11,19 +11,19 @@ The Rust source files are compiled into WebAssembly and so can be readable by th
 If you only want to check if this example compiles, you can run:
 
 ```console
-$ cargo build --example web_app
+cargo build --example web_app
 ```
 
 ## Building
 
 To build this example, you need [wasm-pack](https://github.com/rustwasm/wasm-pack).\
 You can install `wasm-pack` with this command:
 ```console
-$ curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
+curl https://rustwasm.github.io/wasm-pack/installer/init.sh -sSf | sh
 ```
 
 ```console
-$ wasm-pack build examples/web_app/ --target=web --no-typescript
+wasm-pack build examples/web_app/ --target=web --no-typescript
 ```
 
 The compiled files will be stored in the `examples/web_app/pkg` folder.
@@ -33,7 +33,7 @@ The compiled files will be stored in the `examples/web_app/pkg` folder.
 Theoretically, you could just open the `examples/web_app/pkg/index.html` file but due to browsers' security restrictions, you need a web server. For example:
 
 ```console
-$ python3 -m http.server 8080
+python3 -m http.server 8080
 ```
 
 And then go to the `http://localhost:8080/` URL in your browser.

src/lib.rs

@@ -26,8 +26,8 @@
 //!
 //! 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
+//! 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**.