Skip to content

Commit 90f6c0d

Browse files
committed
📖 update readme
Signed-off-by: w01gang <[email protected]>
1 parent 8f82e6f commit 90f6c0d

1 file changed

Lines changed: 14 additions & 6 deletions

File tree

Readme.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@ import { FeatureGateProvider } from 'feature-gate';
1313

1414
// define or get from api features and freeze them
1515
const features = Object.freeze({
16-
feature1: 'true',
16+
feature1: 'default',
17+
feature2: 'extended',
1718
ABtest: 'A',
1819
});
1920

2021
function MyApp() {
21-
const featureFlags = {}; // get from user api
22+
const featureFlags = { // get from user api
23+
feature1: 'default',
24+
feature2: 'none',
25+
ABtest: 'B',
26+
};
2227

2328
return (
2429
<FeatureGateProvider featureFlags={featureFlags} features={features}>
@@ -33,7 +38,7 @@ then anywhere in the app use names of features defined in the features map
3338
import { FeatureGate } from 'feature-gate';
3439

3540
<FeatureGate name="feature1">
36-
<div>Component available for authorized user</div>
41+
<div>Component available for user with feature1 enabled</div>
3742
</FeatureGate>
3843

3944
```
@@ -53,7 +58,7 @@ import { useFeature } from 'feature-gate';
5358
const { enabled: showFeature1 } = useFeature('feature1');
5459
// feature status for the current user
5560
...
56-
{showFeature1 && <div>Component available for authorized user</div>}
61+
{showFeature1 && <div>Component available for user with feature1 enabled</div>}
5762
```
5863
### Advanced usage
5964
A validator function can be provided
@@ -63,7 +68,7 @@ import { FeatureGateProvider } from 'feature-gate';
6368

6469
// define or get from api rules and freeze them
6570
const features = Object.freeze({
66-
feature1: 'true',
71+
feature1: 'default',
6772
ABtest: 'A',
6873
});
6974

@@ -76,7 +81,10 @@ function validator({ featureFlags, features, name }) {
7681
}
7782

7883
function MyApp() {
79-
const featureFlags = {}; // get from user api
84+
const featureFlags = { // get from user api
85+
feature1: 'off',
86+
ABtest: 'A',
87+
};
8088

8189
return (
8290
<FeatureGateProvider featureFlags={featureFlags} features={features} validator={validator}>

0 commit comments

Comments
 (0)