Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Format readme #22

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ npm install --save react-hot-loader

## Usage

1. In the `config-overrides.js` of the root of your project you created for `react-app-rewired` add this code:
#### 1. __In the `config-overrides.js` of the root of your project you created for `react-app-rewired` add this code:__

```JS
```js
const rewireReactHotLoader = require('react-app-rewire-hot-loader')

/* config-overrides.js */
Expand All @@ -28,11 +28,23 @@ module.exports = function override (config, env) {
}
```

2. Follow 'step 2' from https://github.com/gaearon/react-hot-loader , replicated below:
#### 2. __Follow 'step 2' from https://github.com/gaearon/react-hot-loader , replicated below:__

```js
Mark your root component as hot-exported:
// App.js
```js
// App.js - react-hot-loader >= 4.5.4
import React from 'react'
import { hot } from 'react-hot-loader/root'

const App = () => <div>Hello World!</div>

export default process.env.NODE_ENV === "development" ? hot(App) : App
```
Prior to react-hot-loader version 4.5.4. you needed to write `hot(module)(App)`. [react-hot-loader](https://github.com/gaearon/react-hot-loader/tree/v4.7.1#getting-started) recommends to use the latest syntax as
_"it is much more resilient to js errors you may make during development."_

```js
// App.js - react-hot-loader < 4.5.4
import React from 'react'
import { hot } from 'react-hot-loader'

Expand All @@ -41,7 +53,7 @@ const App = () => <div>Hello World!</div>
export default process.env.NODE_ENV === "development" ? hot(module)(App) : App
```

3. Replace 'react-scripts' with 'react-app-rewired' in package.json
#### 3. __Replace 'react-scripts' with 'react-app-rewired' in package.json__

```json
"scripts": {
Expand Down