diff --git a/packages/js/explat/README.md b/packages/js/explat/README.md index e979d611391..1760605110c 100644 --- a/packages/js/explat/README.md +++ b/packages/js/explat/README.md @@ -12,7 +12,7 @@ pnpm install @woocommerce/explat --save This package assumes that your code will run in an ES2015+ environment. If you're using an environment that has limited or no support for ES2015+ such as lower versions of IE then using core-js or @babel/polyfill will add support for these methods. Learn more about it in Babel docs. -## Usage +## Usage with Experiment Component ```js import { Experiment } from '@woocommerce/explat'; @@ -40,3 +40,25 @@ import { ExperimentWithAuth } from '@woocommerce/explat'; loadingExperience={ LoadingExperience } />; ``` + +## Usage with useExperiment + +```js +import { useExperiment } from '@woocommerce/explat'; + +const DefaultExperience =
Hello World
; + +const TreatmentExperience =
Hello WooCommerce!
; + +const LoadingExperience =
; + +const [ isLoadingExperiment, experimentAssignment ] = useExperiment('experiment-name'); + +if ( ! isLoadingExperiment && experimentAssignment?.variationName === 'treatment' ) { + return +} + +return + +```` +