Skip to content
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

Jump to bottom

docs: update README installation instructions #865

Merged
merged 3 commits into from
May 11, 2022
Merged

docs: update README installation instructions #865

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b27c623
docs: update README installation instructions
YOU54F May 10, 2022
3a69814
chore: -D not --D
YOU54F May 10, 2022
d410808
chore: be more explicit in installation instructions
YOU54F May 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
42 changes: 35 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,11 +101,19 @@ Read [Getting started with Pact] for more information for beginners.

## Installation

NPM
```sh
npm install --save-dev @pact-foundation/pact@latest
```
npm i -S @pact-foundation/pact@latest

Yarn

```sh
yarn add --save-dev @pact-foundation/pact@latest
```

Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.
- Ensure you set `--save-dev` or the short-hand `-D` so the Package will appear in your devDependencies [npm docs](https://docs.npmjs.com/cli/v8/commands/npm-install)
- Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.

### Do Not Track

Expand Down Expand Up @@ -947,9 +955,20 @@ package, so you will need to coordinate this yourself prior to and after executi

To get started, install `pact-web` and [Pact Node](https://github.com/pact-foundation/pact-node):

npm install --save-dev @pact-foundation/pact-web @pact-foundation/pact-node
NPM
```sh
npm install --save-dev @pact-foundation/pact-web @pact-foundation/pact-node
```

If you're not using Karma, you can start and stop the mock server using [Pact Node](https://github.com/pact-foundation/pact-node) or something like [Grunt Pact](https://github.com/pact-foundation/grunt-pact).
Yarn

```sh
yarn add --save-dev @pact-foundation/pact-web @pact-foundation/pact-node
```

- Ensure you set `--save-dev` or the short-hand `-D` so the Package will appear in your devDependencies [npm docs](https://docs.npmjs.com/cli/v8/commands/npm-install)
- Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.
- If you're not using Karma, you can start and stop the mock server using [Pact Node](https://github.com/pact-foundation/pact-node) or something like [Grunt Pact](https://github.com/pact-foundation/grunt-pact).

### Using Pact with Karma

Expand Down Expand Up @@ -1022,11 +1041,20 @@ been released. Current support is for Node 10, 12 and 14. Thanks to the folks at

To install it:

```console
npm i @pact-foundation/pact@beta
NPM
```sh
npm install --save-dev @pact-foundation/pact@beta
```

Yarn

```sh
yarn add --save-dev @pact-foundation/pact@beta
```

For examples on how to use it, see [examples/v3/e2e](https://github.com/pact-foundation/pact-js/tree/feat/v3.0.0/examples/v3/e2e) and [examples/v3/todo-consumer](https://github.com/pact-foundation/pact-js/tree/feat/v3.0.0/examples/v3/todo-consumer) in the `v3.0.0` branch.
- Ensure you set `--save-dev` or the short-hand `-D` so the Package will appear in your devDependencies [npm docs](https://docs.npmjs.com/cli/v8/commands/npm-install)
- Make sure the `ignore-scripts` option is disabled, pact uses npm scripts to download further dependencies.
- For examples on how to use it, see [examples/v3/e2e](https://github.com/pact-foundation/pact-js/tree/feat/v3.0.0/examples/v3/e2e) and [examples/v3/todo-consumer](https://github.com/pact-foundation/pact-js/tree/feat/v3.0.0/examples/v3/todo-consumer) in the `v3.0.0` branch.

**NOTE: The API of this implementation is likely to change. See this [discussion](https://github.com/pact-foundation/pact-js/discussions/681) for more**

Expand Down