Skip to content

Remove dollars from bash command examples #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 11, 2021
Merged

Remove dollars from bash command examples #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d4c3a62
Update CONTRIBUTING.md
meili-bot Mar 11, 2021
092d918
Update README.md
meili-bot Mar 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume
### Setup <!-- omit in TOC -->

```bash
$ yarn --dev
yarn --dev
```

### Tests and Linter <!-- omit in TOC -->
Expand All @@ -38,41 +38,41 @@ 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 <!-- omit in TOC -->

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
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down