Skip to content

Commit 03484ee

Browse files
committed
Improve readme
1 parent 4940758 commit 03484ee

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# react-typescript-starter
2-
Simple boilerplate to start a react application using typescript.
2+
Complete setup to start a new React project using Typescript.
33

44

55
## It includes
@@ -17,25 +17,24 @@ Simple boilerplate to start a react application using typescript.
1717
- Jest for unit testing
1818

1919

20-
## Compatibility
21-
The setup is compiling to ES5 and has a polyfill for the fetch API, it should be compatible cross browsers.
22-
23-
2420
## How to use it
2521

2622
Installation (will install typings as well):
2723
```
2824
npm install
2925
```
3026

31-
Runing development server :
27+
- Runing development server :
3228
```
33-
npm run start
29+
npm start
3430
```
3531

36-
For production :
32+
- Build for production :
3733
```
38-
npm run build
34+
npm build
3935
```
4036

41-
Then with your http server target the dist folder
37+
- Run unit tests:
38+
```
39+
npm test
40+
```

0 commit comments

Comments
 (0)