Skip to content

Commit 34d8bf7

Browse files
author
Daniel de la Cruz
committed
Update README.md
1 parent a3b749c commit 34d8bf7

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# react-feature-toggle
22

33
## Introduction
4-
React Toggles is a proof of concept of a Higher Order Component to implement feature toggles.
4+
React Feature Toggle is a proof of concept of a [Higher Order Component](https://gist.github.com/sebmarkbage/ef0bf1f338a7182b6775) to implement [feature toggles](http://martinfowler.com/bliki/FeatureToggle.html).
55

66
## How to use it
7-
First of all, create your component as if it were going to receive by props an array with feature toggles:
7+
First of all, create your component as if it were to receive by props an array with feature toggles:
88

99
```javascript
1010
import React, { Component } from 'react';
@@ -35,7 +35,7 @@ The component will receive a prop named `toggles` with an array of toggles, simi
3535
}]
3636
```
3737

38-
In the previous example, the component will only make use of `myToggle`... But how does it receive it? This is where `react-toggles` is useful.
38+
In the previous example, the component will only make use of `myToggle`... But how does it receive it? This is where `react-feature-toggles` is useful.
3939

4040
First, wrap your component into the higher order component `ReactToggle`:
4141

@@ -45,7 +45,7 @@ import { ReactToggle } from "../src";
4545
export default ReactToggle(MyComponent);
4646
```
4747

48-
This will export your component as a `toggle-able` component.
48+
This will export your component as a _toggleable_ component.
4949

5050
Secondly, the user of your component will need to provide the toggles somehow. It's up to you how to decide which toggles are activated or not, but you must provide the component a `promise` property with a `Promise` function that returns an array of feature toggles on being fullfilled:
5151

0 commit comments

Comments
 (0)