diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c8ff4f70..a575bae2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ### Setup ```bash -$ yarn --dev +yarn --dev ``` ### Tests and Linter @@ -38,17 +38,17 @@ Each PR should pass the tests and the linter to be accepted. ```bash # Tests with Jest -$ 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 -$ yarn test +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 +yarn test # Tests with demos -$ yarn test:demo +yarn test:demo # Linter -$ yarn lint +yarn lint # Linter with fixing -$ yarn lint:fix +yarn lint:fix # Build the project -$ yarn build +yarn build ``` ### Playgrounds @@ -56,23 +56,23 @@ $ yarn build To test directly your changes in `instant-meilisearch`, you can run the Vue playground: ```bash -$ yarn playground:vue +yarn playground:vue ``` Or the React playground: ```bash -$ yarn playground:react +yarn playground:react ``` Or the JavaScript playground: ``` -$ yarn playground:javascript +yarn playground:javascript ``` Or the HTML playground: ``` -$ yarn playground:html +yarn playground:html ``` ## Git Guidelines diff --git a/README.md b/README.md index 9c1563f2..850eb646 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ NB: If you don't have any MeiliSearch instance running and containing your data, Use `npm` or `yarn` to install `instant-meilisearch`: ```bash -$ npm install @meilisearch/instant-meilisearch +npm install @meilisearch/instant-meilisearch ``` ```bash -$ yarn add @meilisearch/instant-meilisearch +yarn add @meilisearch/instant-meilisearch ``` ## Usage