Skip to content

Commit

Permalink
[FSSDK-10121] doc update (#295)
Browse files Browse the repository at this point in the history
  • Loading branch information
@junaed-optimizely
junaed-optimizely authored Nov 15, 2024
1 parent 068382a commit 2ddb3c3
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Optimizely Rollouts is [free feature flags](https://www.optimizely.com/free-feat

Refer to the [React SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/javascript-react-sdk) for detailed instructions on getting started with using the SDK.

For React Native, review the [React Native developer documentation](https://docs.developers.optimizely.com/feature-experimentation/docs/javascript-react-native-sdk) for installation and implementation detail.
For React Native, review the [React Native developer documentation](https://docs.developers.optimizely.com/feature-experimentation/docs/javascript-react-native-sdk).


### Features
Expand Down Expand Up @@ -70,6 +70,10 @@ class App extends React.Component {
npm install @optimizely/react-sdk
```

For **React Native**, installation instruction is bit different. Check out the
- [Official Installation guide](https://docs.developers.optimizely.com/feature-experimentation/docs/install-sdk-reactnative)
- [Expo React Native Sample App](https://github.com/optimizely/expo-react-native-sdk-sample)

## Use the React SDK

### Initialization
Expand Down

1 comment on commit 2ddb3c3

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Jest Coverage Report

Caution

Test run failed

St.❔
 Category Percentage Covered / Total
🟢 Statements 98.95% 849/858
🟢 Branches 91.71% 343/374
🟢 Functions 97.52% 157/161
🟢 Lines 99.1% 767/774

Test suite run failed

Failed tests: 1/265. Failed suites: 1/10. 
  ● hooks › useDecision › should not re-render when the user attributes change without autoUpdate

    expect(element).toHaveTextContent()

    Expected element to have text content:
      false|{}|true|false
    Received:
      true|{"foo":"bar"}|true|false

    Ignored nodes: comments, script, style
    <html>
      <head />
      <body>
        <div>
          <span
            data-testid="result"
          >
            true|{"foo":"bar"}|true|false
          </span>
        </div>
      </body>
    </html>

      970 |         userUpdateCallbacks.forEach((fn) => fn());
      971 |       });
    > 972 |       await waitFor(() => expect(screen.getByTestId('result')).toHaveTextContent('false|{}|true|false'));
          |                                                                ^
      973 |     });
      974 |
      975 |     it('should return the decision immediately on the first call when the client is already ready', async () => {

      at src/hooks.spec.tsx:972:64
      at runWithExpensiveErrorDiagnosticsDisabled (node_modules/@testing-library/dom/dist/config.js:47:12)
      at checkCallback (node_modules/@testing-library/dom/dist/wait-for.js:124:77)
      at checkRealTimersCallback (node_modules/@testing-library/dom/dist/wait-for.js:118:16)
      at Timeout.task [as _onTimeout] (node_modules/jsdom/lib/jsdom/browser/Window.js:520:19)

Report generated by 🧪jest coverage report action from 2ddb3c3

Please sign in to comment.