Skip to content

Commit 319d079

Browse files
authored
Update installation instructions
* Remove documentation of --init option * Change @ava/init to create-ava It's more idiomatic. * Advocate saving exact versions while in beta Since we're not bumping the version number in the beta releases, *each* beta release is matched by the ^ modifier. Save exact versions so prevent accidentally breaking user installations. We'll remove this when releasing the final version.
1 parent 6bba766 commit 319d079

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

readme.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ test('arrays are equal', t => {
7575
To install and set up AVA, run:
7676

7777
```console
78-
$ npx @ava/init --next
78+
$ npx create-ava --next
7979
```
8080

8181
Your `package.json` will then look like this:
@@ -87,21 +87,21 @@ Your `package.json` will then look like this:
8787
"test": "ava"
8888
},
8989
"devDependencies": {
90-
"ava": "^1.0.0-beta.3"
90+
"ava": "1.0.0-beta.4"
9191
}
9292
}
9393
```
9494

9595
Initialization will work with npm and Yarn, but running `npx` requires [`[email protected]`](https://github.com/npm/npm/releases/tag/v5.2.0) or greater to be installed. Otherwise, you'll have to manually install `ava` and configure the `test` script in your `package.json` as per above:
9696

9797
```console
98-
$ npm install --save-dev ava@next
98+
$ npm install --save-dev --save-exact ava@next
9999
```
100100

101101
Or if you prefer using Yarn:
102102

103103
```console
104-
$ yarn add --dev ava@next
104+
$ yarn add ava@next --dev --exact
105105
```
106106

107107
### Create your test file
@@ -149,7 +149,6 @@ $ ava --help
149149
ava [<file|directory|glob> ...]
150150

151151
Options
152-
--init Add AVA to your project
153152
--watch, -w Re-run tests when tests and source files change
154153
--match, -m Only run tests with matching title (Can be repeated)
155154
--update-snapshots, -u Update snapshots
@@ -168,7 +167,6 @@ $ ava --help
168167
ava test.js test2.js
169168
ava test-*.js
170169
ava test
171-
ava --init
172170

173171
Default patterns when no arguments:
174172
test.js test-*.js test/**/*.js **/__tests__/**/*.js **/*.test.js

0 commit comments

Comments
 (0)