Updated create-subscription description
Brian Vaughn committed
Mar 14, 2018 at 15:39 UTC
ced176edb7605a25e916895fd060f3943c647fee
2 files changed
+3
-3
packages/create-subscription/README.md
+2
-2
@@ -1,6 +1,6 @@
1
# create-subscription
2
3
-`create-subscription` provides an async-safe interface to manage a subscription.
3
+`create-subscription` is a utility for subscribing to external data sources inside React components. It is officially supported and maintained by the React team.
4
5
## When should you NOT use this?
6
@@ -50,7 +50,7 @@ const Subscription = createSubscription({
50
});
51
```
52
53
-To use the `Subscription` component, pass the subscribable property (e.g. an event dispatcher, Flux store, observable) as the `source` property and use a [render prop](https://reactjs.org/docs/render-props.html), `children`, to handle the subscribed value when it changes:
53
+To use the `Subscription` component, pass the subscribable property (e.g. an event dispatcher, observable) as the `source` property and use a [render prop](https://reactjs.org/docs/render-props.html), `children`, to handle the subscribed value when it changes:
54
55
```js
56
<Subscription source={eventDispatcher}>
packages/create-subscription/package.json
+1
-1
@@ -1,6 +1,6 @@
1
{
2
"name": "create-subscription",
3
- "description": "HOC for creating async-safe React components with subscriptions",
3
+ "description": "utility for subscribing to external data sources inside React components",
4
"version": "0.1.0-alpha.2",
5
"repository": "facebook/react",
6
"files": [