Skip to content

Commit 026ef65

Browse files
committed
fix(docs): Add troublesshoting section
1 parent 455ee5b commit 026ef65

1 file changed

Lines changed: 19 additions & 14 deletions

File tree

README.md

Lines changed: 19 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@ It supports all features of TypeScript including type-checking. [Read more about
99
---
1010

1111
| We are not doing semantic versioning and `23.10` is a re-write, run `npm i -D ts-jest@"<23.10.0"` to go back to the previous version |
12-
|---|
12+
| ------------------------------------------------------------------------------------------------------------------------------------ |
13+
1314

1415
[<img src="./docs/assets/img/documentation.png" align="left" height="24"> View the online documentation (usage & technical)](https://kulshekhar.github.io/ts-jest)
1516

@@ -27,33 +28,37 @@ It supports all features of TypeScript including type-checking. [Read more about
2728

2829
These instructions will get you setup to use `ts-jest` in your project. For more detailed documentation, please check [online documentation](https://kulshekhar.github.io/ts-jest).
2930

30-
| | using npm | using yarn |
31-
|---:|---|---|
32-
| **Prerequisites** | `npm i -D jest typescript` | `yarn add --dev jest typescript` |
33-
| **Installing** | `npm i -D ts-jest @types/jest` | `yarn add --dev ts-jest @types/jest` |
34-
| **Creating config** | `npx ts-jest config:init` | `yarn ts-jest config:init` |
35-
| **Running tests** | `npm t` or `npx jest` | `yarn test` or `yarn jest` |
31+
| | using npm | using yarn |
32+
| ------------------: | ------------------------------ | ------------------------------------ |
33+
| **Prerequisites** | `npm i -D jest typescript` | `yarn add --dev jest typescript` |
34+
| **Installing** | `npm i -D ts-jest @types/jest` | `yarn add --dev ts-jest @types/jest` |
35+
| **Creating config** | `npx ts-jest config:init` | `yarn ts-jest config:init` |
36+
| **Running tests** | `npm t` or `npx jest` | `yarn test` or `yarn jest` |
3637

3738
## Built With
3839

39-
* [TypeScript](https://www.typescriptlang.org/) - JavaScript that scales
40-
* [Jest](https://jestjs.io/) - Delightful JavaScript Testing
41-
* [`ts-jest`](https://kulshekhar.github.io/ts-jest) - Jest processor for TypeScript _(yes, `ts-jest` uses itself for its tests)_
40+
- [TypeScript](https://www.typescriptlang.org/) - JavaScript that scales
41+
- [Jest](https://jestjs.io/) - Delightful JavaScript Testing
42+
- [`ts-jest`](https://kulshekhar.github.io/ts-jest) - Jest processor for TypeScript _(yes, `ts-jest` uses itself for its tests)_
4243

4344
## Contributing
4445

4546
Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
4647

48+
## Troubleshooting
49+
50+
Please read [TROUBLESHOOTING.md](TROUBLESHOOTING.md) for problems may arise when you're using ts-jest.
51+
4752
## Versioning
4853

4954
We **DO NOT** use [SemVer](http://semver.org/) for versioning. Though you can think about SemVer when reading our version, except our major number follows the one of Jest. For the versions available, see the [tags on this repository](https://github.com/kulshekhar/ts-jest/tags).
5055

5156
## Authors/maintainers
5257

53-
* **Kulshekhar Kabra** - [kulshekhar](https://github.com/kulshekhar)
54-
* **Gustav Wengel** - [GeeWee](https://github.com/GeeWee)
55-
* **Ahn** - [ahnpnl](https://github.com/ahnpnl)
56-
* **Huafu Gandon** - [huafu](https://github.com/huafu)
58+
- **Kulshekhar Kabra** - [kulshekhar](https://github.com/kulshekhar)
59+
- **Gustav Wengel** - [GeeWee](https://github.com/GeeWee)
60+
- **Ahn** - [ahnpnl](https://github.com/ahnpnl)
61+
- **Huafu Gandon** - [huafu](https://github.com/huafu)
5762

5863
See also the list of [contributors](https://github.com/kulshekhar/ts-jest/contributors) who participated in this project.
5964

0 commit comments

Comments
 (0)