Skip to content

Commit c822f95

Browse files
authored
Remove dollars from bash command examples (#65)
* Update CONTRIBUTING.md * Update README.md
1 parent 622f941 commit c822f95

File tree

2 files changed

+21
-21
lines changed

2 files changed

+21
-21
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
3232
We suggest using `yarn` as the lock file is in yarn and thus we ensure a working dev environment.
3333

3434
```bash
35-
$ yarn
35+
yarn
3636
```
3737

3838
### Tests and Linter <!-- omit in toc -->
@@ -41,23 +41,23 @@ Each PR should pass the tests and the linter to be accepted.
4141

4242
```bash
4343
# Run a MeiliSearch instance
44-
$ docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
45-
$ docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
44+
docker pull getmeili/meilisearch:latest # Fetch the latest version of MeiliSearch image from Docker Hub
45+
docker run -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics=true
4646

4747
# Tests the project
48-
$ yarn develop
48+
yarn develop
4949
# Linter
50-
$ yarn lint
50+
yarn lint
5151
# Linter with fixing
52-
$ yarn lint:fix
52+
yarn lint:fix
5353
```
5454

5555
### Playgrounds
5656

5757
To test directly your changes on the plugin in Strapi, you can run the Strapi playground:
5858

5959
```bash
60-
$ yarn playground:dev
60+
yarn playground:dev
6161
```
6262

6363
## Git Guidelines

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,17 @@ Until this package is released on `npm`, you can use it the following way:
2222
To use this project you will need to clone it:
2323

2424
```
25-
$ git clone [email protected]:meilisearch/strapi-plugin-meilisearch.git
26-
$ cd strapi-plugin-meilisearch
25+
git clone [email protected]:meilisearch/strapi-plugin-meilisearch.git
26+
cd strapi-plugin-meilisearch
2727
```
2828

2929
Install all required dependencies:
3030
```bash
3131
# with yarn
32-
$ yarn install
32+
yarn install
3333

3434
# with yarn
35-
$ npm install
35+
npm install
3636
```
3737

3838
### Using playground
@@ -41,15 +41,15 @@ Instead of adding the plugin to an existing project, you can try it out using th
4141

4242
```bash
4343
# with yarn
44-
$ yarn develop
44+
yarn develop
4545
```
4646

4747
Or if you want to use `npm`, by going inside the directory:
4848
```bash
4949
# with npm
50-
$ cd playground
51-
$ npm install
52-
$ npm run develop
50+
cd playground
51+
npm install
52+
npm run develop
5353
```
5454

5555
Install Strapi with this **Quickstart** command to create a Strapi project instantly:
@@ -61,10 +61,10 @@ Install Strapi with this **Quickstart** command to create a Strapi project insta
6161

6262
```bash
6363
# with yarn
64-
$ yarn create strapi-app my-project --quickstart
64+
yarn create strapi-app my-project --quickstart
6565

6666
# with npm/npx
67-
$ npx create-strapi-app my-project --quickstart
67+
npx create-strapi-app my-project --quickstart
6868
```
6969

7070
_This command generates a brand new project with the default features (authentication, permissions, content management, content type builder & file upload). The **Quickstart** command installs Strapi using a **SQLite** database which is used for prototyping in development._
@@ -75,18 +75,18 @@ Once your Strapi project has been created, to link the plugin to this project yo
7575
1. Create plugin folder
7676

7777
```bash
78-
$ mkdir plugins
78+
mkdir plugins
7979
```
8080
2. Create symbolic link
8181

8282
```bash
83-
$ cd plugins
84-
$ ln -s [PATH_TO_PLUGIN] meilisearch
83+
cd plugins
84+
ln -s [PATH_TO_PLUGIN] meilisearch
8585
```
8686
3. Develop
8787

8888
```bash
89-
$ yarn develop
89+
yarn develop
9090
```
9191

9292
You can now use the plugin on your Strapi project.

0 commit comments

Comments
 (0)