Skip to content
This repository was archived by the owner on Dec 4, 2024. It is now read-only.

Commit 21d9c02

Browse files
committed
📝 docs: update README
closes #3
1 parent 27d5974 commit 21d9c02

File tree

1 file changed

+42
-2
lines changed

1 file changed

+42
-2
lines changed

README.md

Lines changed: 42 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,53 @@
11
# :globe_with_meridians: vue-i18n-jest
22

3-
43
[![npm](https://img.shields.io/npm/v/vue-i18n-jest.svg)](https://www.npmjs.com/package/vue-i18n-jest)
54
[![CircleCI](https://circleci.com/gh/kazupon/vue-i18n-jest/tree/master.svg?style=svg)](https://circleci.com/gh/kazupon/vue-i18n-jest/tree/master)
65
[![codecov](https://codecov.io/gh/kazupon/vue-i18n-jest/branch/master/graph/badge.svg)](https://codecov.io/gh/kazupon/vue-i18n-jest)
76

87
vue-jest wrapper for i18n custom blocks
98

10-
:warning: WIP
9+
## :cd: Installation
10+
11+
### npm
12+
13+
```sh
14+
npm install --save-dev vue-i18n-jest
15+
```
16+
17+
### yarn
18+
19+
```sh
20+
yarn add -D vue-i18n-jest
21+
```
22+
23+
## :rocket: Usages
24+
25+
To define vue-i18n-jest as a transformer for your .vue files that have i18n custom blocks, map them to the vue-i18n-jest module.
26+
27+
if you've already setup vue-jest, You can change it as follows:
28+
29+
```diff
30+
{
31+
"jest": {
32+
// ...
33+
"transform": {
34+
- "^.+\\.vue$": "vue-jest"
35+
+ "^.+\\.vue$": "vue-i18n-jest"
36+
},
37+
// ....
38+
}
39+
```
40+
41+
42+
## :scroll: Changelog
43+
Details changes for each release are documented in the [CHANGELOG.md](https://github.com/kazupon/vue-i18n-jest/blob/master/CHANGELOG.md).
44+
45+
46+
## :exclamation: Issues
47+
Please make sure to read the [Issue Reporting Checklist](https://github.com/kazupon/vue-i18n-jest/blob/master/.github/CONTRIBUTING.md#issue-reporting-guidelines) before opening an issue. Issues not conforming to the guidelines may be closed immediately.
48+
49+
## :white_check_mark: TODO
50+
Managed with [GitHub Projects](https://github.com/kazupon/vue-i18n-jest/issues?q=is%3Aissue+is%3Aopen+label%3ATODO)
1151

1252
## :copyright: License
1353

0 commit comments

Comments
 (0)