Skip to content

Commit fe4d86d

Browse files
committed
Readme improvements
1 parent d22fda9 commit fe4d86d

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,28 @@
1-
# A quick start Redux Create React App template
1+
# A quick start Redux + TypeScript Create React App template
22

3-
An opinionated quick start [Create React App](https://github.com/facebook/create-react-app) (CRA) template with **Redux**, **TypeScript**, **React Router**, **Enzyme** and custom ESlint configuration.
3+
An opinionated quick start [Create React App](https://github.com/facebook/create-react-app) (CRA) _template_ with configured **Redux**, **TypeScript**, **React Router**, **Enzyme** and custom **ESlint** configuration.
44

55
Original Create React App README available [here](./README_CRA.md)
66

77
## Usage
88

9-
`npx create-react-app <your-project_name> --template typescript-redux`
9+
```bash
10+
npx create-react-app your-project-name --template typescript-redux
11+
```
1012

1113
Or
1214

13-
`yarn create react-app <your-project_name> --template typescript-redux`
15+
```bash
16+
yarn create react-app your-project-name --template typescript-redux
17+
```
1418

15-
`npx` command installs most recent stable version of CRA from npm. `--template` parameter points to this template, note that `cra-template-` prefix is omitted.
19+
`npx` command installs the most recent stable version of CRA from npm.
20+
21+
`--template` parameter points to this template, note that `cra-template-` prefix is omitted.
1622

1723
## Motivation
1824

19-
You know the pain. You start a new project and need to configure it again and again. It needs routing, ok you setup Router, then you need Redux - ok, oh. Wait... All of these tools you get used to. Redux boilerplate is taking some much to type. I want just to focus on building amazing projects and not spending hours configuring tools. That's why I've created this template. It's for you to use.
25+
You know the pain. You start a new project from scratch and need to configure it again and again. It needs routing, ok you setup Router, then you need Redux - ok, oh 😩Redux boilerplate is taking so much time to type. Wait... what if you could have all the tools you want just from the beginning? I want to focus on building amazing projects and not spending hours configuring. That's why I've created this template. It's here for you to use.
2026

2127
## Available Scripts
2228

@@ -38,21 +44,21 @@ Due to CRA template limitations (we can change only `scripts` and `dependencies`
3844

3945
## Redux configuration
4046

41-
Template provides basic Redux configuration with [feature based](https://redux.js.org/style-guide/style-guide/#structure-files-as-feature-folders-or-ducks) folder structure. You can use [Redux devtools browser extension](http://extension.remotedev.io/). Sample feature included in `src/features` folder, note technology agnostic `features` folder name. Based on Redux maintainers recommendation.
47+
The template provides basic Redux configuration with [feature based](https://redux.js.org/style-guide/style-guide/#structure-files-as-feature-folders-or-ducks) folder structure. You can use [Redux devtools browser extension](http://extension.remotedev.io/). Sample feature included in `src/features` folder, note technology agnostic `features` folder name. Based on Redux maintainers recommendation.
4248

4349
## Testing
4450

45-
Snapshot testing done with [Enzyme](https://airbnb.io/enzyme/).
51+
Testing is configured with [Enzyme](https://airbnb.io/enzyme/).
4652

4753
## [Prettier](https://prettier.io/)
4854

4955
I added `prettier` to force consistent formatting. Don't like trailing semicolons? Feel free to [tweak prettier rules](https://prettier.io/docs/en/configuration.html) inside `.prettierrc` file to match your code style.
5056

5157
## Eslint configurations
5258

53-
Template extends CRA eslint rules with custom set, tailored for reasonable and clean development process.
59+
The template extends CRA ESLint rules with a custom set, tailored for the reasonable and clean development process.
5460

55-
Eslint rules are commented for your convenience feel free to tweak or remove them inside `.eslintrc`. No judgement.
61+
Eslint rules are commented for your convenience feel free to tweak or remove them inside `.eslintrc`. No judgment.
5662

5763
## Thank you
5864

0 commit comments

Comments
 (0)