Permalink
Browse files

Updated create-subscription description

  • Loading branch information...
bvaughn committed Mar 14, 2018
1 parent ccec542 commit ced176edb7605a25e916895fd060f3943c647fee
Showing with 3 additions and 3 deletions.
  1. +2 −2 packages/create-subscription/README.md
  2. +1 −1 packages/create-subscription/package.json
@@ -1,6 +1,6 @@
# create-subscription
`create-subscription` provides an async-safe interface to manage a subscription.
`create-subscription` is a utility for subscribing to external data sources inside React components. It is officially supported and maintained by the React team.
## When should you NOT use this?
@@ -50,7 +50,7 @@ const Subscription = createSubscription({
});
```
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:
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:
```js
<Subscription source={eventDispatcher}>
@@ -1,6 +1,6 @@
{
"name": "create-subscription",
"description": "HOC for creating async-safe React components with subscriptions",
"description": "utility for subscribing to external data sources inside React components",
"version": "0.1.0-alpha.2",
"repository": "facebook/react",
"files": [

0 comments on commit ced176e

Please sign in to comment.