Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/react-native-openfeature/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Datadog OpenFeature Provider for React Native

Use [OpenFeature][1] with [Datadog Feature Flags][2] to evaluate feature flags and send flag evaluation data to Datadog for monitoring analysis and experimentation.
Use [OpenFeature][1] with [Datadog Feature Flags][2] to evaluate feature flags and send evaluation data to Datadog for analysis and experimentation.

This package provides an OpenFeature-compatible provider that wraps Datadog's Feature Flags SDK.

Expand All @@ -10,7 +10,7 @@ OpenFeature is a vendor-neutral, community-driven specification and SDK for feat

## Setup

**Note**: This package is an integration for the [OpenFeature React SDK][1]. Before using it, install and set up the core [`mobile-react-native`][3] SDK.
**Note**: This package is an integration for the [OpenFeature React SDK][1]. Before starting using Datadog Feature Flags, install and set up the core [`@datadog/mobile-react-native`][3] SDK.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Note**: This package is an integration for the [OpenFeature React SDK][1]. Before starting using Datadog Feature Flags, install and set up the core [`@datadog/mobile-react-native`][3] SDK.
**Note**: This package is an integration for the [OpenFeature React SDK][1]. Install and set up the core [`@datadog/mobile-react-native`][3] SDK to start using Datadog Feature Flags.


To install with NPM, run:

Expand All @@ -30,8 +30,6 @@ yarn add @datadog/mobile-react-native @datadog/mobile-react-native-openfeature @

Use the example code snippet below to initialize the Datadog SDK, enable the Feature Flags feature, and set up the OpenFeature provider.

After completing this setup, your app should be ready for flag evaluation with OpenFeature.

```tsx
import { CoreConfiguration, DatadogProvider, DdFlags } from '@datadog/mobile-react-native';
import { DatadogOpenFeatureProvider } from '@datadog/mobile-react-native-openfeature';
Expand Down Expand Up @@ -67,6 +65,8 @@ import { OpenFeature } from '@openfeature/react-sdk';
</DatadogProvider>
```

After completing this setup, your app should be ready for flag evaluation with OpenFeature.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After completing this setup, your app should be ready for flag evaluation with OpenFeature.
After completing this setup, your app is ready for flag evaluation with OpenFeature.


> **Note**: Sending flag evaluation data to Datadog is automatically enabled when using the Feature Flags SDK. Provide `rumIntegrationEnabled` and `trackExposures` parameters to the `DdFlags.enable()` call to configure this.

### Using the OpenFeature React SDK
Expand Down
Loading