Skip to content

Commit f0ed142

Browse files
authored
update readme based on #140
1 parent f79a96e commit f0ed142

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
11
# vue-jest
22

3-
Jest Vue transformer with source map support
3+
Jest transformer for Vue single file components
44

55
> **NOTE:** This is documentation for `[email protected]`. [View the [email protected] documentation](https://github.com/vuejs/vue-jest/tree/v3)
66
77
## Usage
88

99
```bash
1010
npm install --save-dev vue-jest
11+
yarn add vue-jest --dev
1112
```
1213

1314
## Setup
1415

15-
To define `vue-jest` as a transformer for your `.vue` files, map them to the `vue-jest` module:
16+
To use `vue-jest` as a transformer for your `.vue` files, map them to the `vue-jest` module:
1617

1718
```json
1819
{
@@ -38,16 +39,15 @@ A full config will look like this.
3839
}
3940
```
4041

41-
## Example Projects
42+
## Examples
4243

4344
Example repositories testing Vue components with jest and vue-jest:
4445

45-
- [Avoriaz with Jest](https://github.com/eddyerburgh/avoriaz-jest-example)
4646
- [Vue Test Utils with Jest](https://github.com/eddyerburgh/vue-test-utils-jest-example)
4747

4848
## Supported langs
4949

50-
vue-jest compiles the script and template of SFCs into a JavaScript file that Jest can run. **Currently, SCSS, SASS and Stylus are the only style languages that are compiled**.
50+
vue-jest compiles `<script />`, `<template />`, and `<style />` blocks with supported `lang` attributes into JavaScript that Jest can run.
5151

5252
### Supported script languages
5353

0 commit comments

Comments
 (0)