Skip to content

Commit 6df8281

Browse files
committed
Editing Readme WIP
1 parent fcad38d commit 6df8281

File tree

1 file changed

+6
-48
lines changed

1 file changed

+6
-48
lines changed

README.md

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -4,61 +4,19 @@ Spearmint helps developers easily create functional React/Redux/Endpoint/Paint T
44

55
# How to use
66

7-
Download spearmint @ spearmintjs.com. Available for Mac OS and Windows.
7+
Download spearmint @ spearmintjs.com. Available for Mac OS, Windows and Linux.
88

9-
<br>
10-
11-
### React Testing
12-
<hr>
13-
To run React tests generated by spearmint, install the following in your dev dependencies.
14-
15-
npm i -D jest @testing-library/jest-dom @testing-library/react test-data-bot
16-
17-
To run Redux tests generated by spearmint, install the following in your dev dependencies, in addition to your React test installations above.
18-
19-
npm i -D redux-mock-store redux-thunk fetch-mock
20-
21-
To run Hooks / Context tests generated by spearmint, install the following in your dev dependencies, in addition to your React test installations above.
22-
23-
npm i -D @testing-library/react-hooks
249

10+
Mac users:
11+
### Pre-requisite
12+
* Download latest version of Xcode
13+
* run "npm install-once" to install dependencies and run electron rebuild sequentially
14+
2515
<br>
2616

27-
### Endpoint Testing
28-
<hr>
29-
To run Endpoint tests generated by spearmint, install the following in your dev dependencies.
30-
31-
npm i -D jest supertest
32-
33-
<br>
34-
35-
### Puppeteer Testing
36-
<hr>
37-
To run Puppeteer tests generated by spearmint, install the following in your dev dependencies.
3817

39-
npm i -D jest puppeteer
4018

4119

42-
<br>
43-
44-
### Accessiblity Testing
45-
<hr>
46-
47-
To run Accessibility tests generated by spearmint on HTML, install the following in your dev dependencies.
48-
49-
npm i -D axe-core regenerator-runtime jest
50-
51-
To run Accessibility tests generated by spearmint on React Components, install the following in your dev dependencies.
52-
53-
npm i -D axe-core regenerator-runtime jest enzyme enzyme-adapter-react-16
54-
55-
To run Accessibility tests generated by spearmint on URL's with Puppeteer, install the following in your dev dependencies.
56-
57-
npm i -D axe-core puppeteer
58-
59-
60-
<br>
61-
6220
# How it works
6321

6422
1. On the initial screen, enter the URL of your project and load your application to start creating tests.

0 commit comments

Comments
 (0)