Update comments and metadata

Author: EmilianoSanchez

README.md

@@ -18,7 +18,7 @@ Below is a simple example that describes the instantiation and most basic usage
 import React from 'react';
 
 // Import SDK functions
-import { SplitFactoryProvider, useSplitTreatments } from '@splitsoftware/splitio-react';
+import { SplitFactoryProvider, useTreatment } from '@splitsoftware/splitio-react';
 
 // Define your config object
 const CONFIG = {
@@ -29,18 +29,18 @@ const CONFIG = {
 };
 
 function MyComponent() {
-  // Evaluate feature flags with useSplitTreatments hook
-  const { treatments: { FEATURE_FLAG_NAME }, isReady } = useSplitTreatments({ names: ['FEATURE_FLAG_NAME'] });
+  // Evaluate a feature flag with useTreatment hook
+  const { treatment, isReady } = useTreatment({ name: 'FEATURE_FLAG_NAME' });
 
   // Check SDK readiness using isReady prop
   if (!isReady) return <div>Loading SDK ...</div>;
 
-  if (FEATURE_FLAG_NAME.treatment === 'on') {
-    // return JSX for on treatment
-  } else if (FEATURE_FLAG_NAME.treatment === 'off') {
-    // return JSX for off treatment
+  if (treatment === 'on') {
+    // return JSX for 'on' treatment
+  } else if (treatment === 'off') {
+    // return JSX for 'off' treatment
   } else {
-    // return JSX for control treatment
+    // return JSX for 'control' treatment
   };
 }
 

src/SplitClient.tsx

@@ -9,8 +9,6 @@ import { useSplitClient } from './useSplitClient';
  *
  * The underlying SDK client can be changed during the component lifecycle
  * if the component is updated with a different splitKey prop.
- *
- * @deprecated `SplitClient` will be removed in a future major release. We recommend replacing it with the `useSplitClient` hook.
  */
 export function SplitClient(props: ISplitClientProps) {
   const { children } = props;

src/SplitTreatments.tsx

@@ -9,7 +9,7 @@ import { useSplitTreatments } from './useSplitTreatments';
  * call the 'client.getTreatmentsWithConfig()' method if the `names` prop is provided, or the 'client.getTreatmentsWithConfigByFlagSets()' method
  * if the `flagSets` prop is provided. It then passes the resulting treatments to a child component as a function.
  *
- * @deprecated `SplitTreatments` will be removed in a future major release. We recommend replacing it with the `useSplitTreatments` hook.
+ * @deprecated `SplitTreatments` will be removed in a future major release. We recommend replacing it with the `useTreatment*` hooks.
  */
 export function SplitTreatments(props: ISplitTreatmentsProps) {
   const { children } = props;

src/withSplitTreatments.tsx

@@ -10,7 +10,7 @@ import { SplitTreatments } from './SplitTreatments';
  * @param names - list of feature flag names
  * @param attributes - An object of type Attributes used to evaluate the feature flags.
  *
- * @deprecated `withSplitTreatments` will be removed in a future major release. We recommend replacing it with the `useSplitTreatments` hook.
+ * @deprecated `withSplitTreatments` will be removed in a future major release. We recommend replacing it with the `useTreatment*` hooks.
  */
 export function withSplitTreatments(names: string[], attributes?: SplitIO.Attributes) {