Skip to content

Commit 9d51c04

Browse files
author
Michael Jackson
committed
README tweaks
1 parent 30c4225 commit 9d51c04

File tree

1 file changed

+7
-22
lines changed

1 file changed

+7
-22
lines changed

README.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,28 +5,15 @@
55
[npm-badge]: https://img.shields.io/npm/v/react-broadcast.svg?style=flat-square
66
[npm]: https://www.npmjs.com/package/react-broadcast
77

8-
[`react-broadcast`](https://www.npmjs.com/package/react-broadcast) provides a reliable way for React
9-
components to propagate state changes to their descendants deep in the component hierarchy,
10-
bypassing intermediaries who `return false` from
11-
[`shouldComponentUpdate`](https://reactjs.org/docs/react-component.html#shouldcomponentupdate).
12-
13-
It was originally built to solve issues that arose from using
14-
[`react-router`](https://www.npmjs.com/package/react-router) together with
15-
[`react-redux`](https://www.npmjs.com/package/react-redux). The router needed a safe way to
16-
communicate state changes to `<Link>`s deep in the component hierarchy, but `react-redux` relies on
17-
`shouldComponentUpdate` for performance. `react-broadcast` allows the router to work seamlessly with
18-
Redux and any other component that uses `shouldComponentUpdate`.
19-
20-
**Please note:** As with anything that uses [context](https://reactjs.org/docs/context.html), this
21-
library is experimental. It may cease working in some future version of React. For now, it's a
22-
practical workaround for the router. If we discover some better way to do things in the future, rest
23-
assured we'll do our best to share what we learn.
8+
[`react-broadcast`](https://www.npmjs.com/package/react-broadcast) provides a reliable way for React components to propagate state changes to their descendants deep in the component hierarchy, bypassing intermediaries who `return false` from [`shouldComponentUpdate`](https://reactjs.org/docs/react-component.html#shouldcomponentupdate).
249

25-
## Installation
10+
It was originally built to solve issues that arose from using [`react-router`](https://www.npmjs.com/package/react-router) together with [`react-redux`](https://www.npmjs.com/package/react-redux). The router needed a safe way to communicate state changes to `<Link>`s deep in the component hierarchy, but `react-redux` relies on `shouldComponentUpdate` for performance. `react-broadcast` allows the router to work seamlessly with Redux and any other component that uses `shouldComponentUpdate`.
11+
12+
**Please note:** As with anything that uses [context](https://reactjs.org/docs/context.html), this library is experimental. It may cease working in some future version of React. For now, it's a practical workaround for the router. If we discover some better way to do things in the future, rest assured we'll do our best to share what we learn.
2613

27-
Using [yarn](https://yarnpkg.com/):
14+
## Installation
2815

29-
$ yarn add react-broadcast
16+
$ npm install --save react-broadcast
3017

3118
Then, use as you would anything else:
3219

@@ -105,6 +92,4 @@ Enjoy!
10592

10693
## About
10794

108-
react-broadcast is developed and maintained by [React Training](https://reacttraining.com). If
109-
you're interested in learning more about what React can do for your company, please [get in
110-
touch](mailto:[email protected])!
95+
react-broadcast is developed and maintained by [React Training](https://reacttraining.com). If you're interested in learning more about what React can do for your company, please [get in touch](mailto:[email protected])!

0 commit comments

Comments
 (0)