@configdirector/react-native-sdk 0.1.0 → 0.1.1

package/README.md

@@ -10,15 +10,94 @@ Install from NPM:
 npm install --save @configdirector/react-native-sdk
 ```
 
+### 2. Initialize the provider using your client SDK key
 
-## Usage
+```tsx
+import { View } from "react-native";
+import AwesomeApp from "./AwesomeApp";
+import { ConfigDirectorProvider } from "@configdirector/react-native-sdk";
+
+export default function App() {
+  return (
+    <ConfigDirectorProvider
+      sdkKey={"YOUR-CLIENT-SDK-KEY"}
+      appName="MyAwesomeApp"
+      appVersion="1.0.0">
+      <View>
+        <AwesomeApp />
+      </View>
+    </ConfigDirectorProvider>
+  );
+}
+```
 
+### 3. Retrieve config values
+
+Retrieve a config value with the `useConfigValue` hook:
 
 ```tsx
-import { createClient } from "@configdirector/react-native-sdk";
+import { useConfigValue } from "@configdirector/react-native-sdk";
+
+function MyComponent() {
+  const { value } = useConfigValue<string>("my-config", "default value");
 
+  return <p>My config value: {value}</p>;
+}
+
+export default MyComponent;
 ```
 
+You can also determine if the client is still initializing, so rather than transition from the default value to the evaluated value, you can show a loading state until the client is ready and config values are evaluated:
+
+```tsx
+import { useConfigValue } from "@configdirector/react-native-sdk";
+
+function MyComponent() {
+  const { value, loading } = useConfigValue<string>(
+    "my-config",
+    "default value",
+  );
+
+  if (loading) {
+    return <p>Loading...</p>;
+  } else {
+    return <p>My config value: {value}</p>;
+  }
+}
+
+export default MyComponent;
+```
+
+### 4. Updating the user context
+
+Update the user context with the `useConfigDirectorContext` hook:
+
+```tsx
+import {
+  useConfigValue,
+  useConfigDirectorContext,
+} from "@configdirector/react-native-sdk";
+
+function MyComponent() {
+  const { value: myConfigValue } = useConfigValue<string>(
+    "my-config",
+    "default value",
+  );
+  const { updateContext } = useConfigDirectorContext();
+
+  useEffect(() => {
+    updateContext({
+      id: "54321",
+      name: "Another User",
+      traits: { customProperty: "customValue" },
+    });
+  }, []);
+
+  return <p>My config value: {myConfigValue}</p>;
+}
+
+export default MyComponent;
+```
 
 ## Requirements
 
@@ -37,3 +116,7 @@ Expo SDK 48 (RN 0.71) or later is required.
 ## License
 
 MIT
+
+## Getting Help
+
+Reach out to us via https://www.configdirector.com/support

package/dist/configdirector-react-native.mjs

@@ -1377,7 +1377,7 @@ const createClient = (clientSdkKey, clientOptions) => {
 	const logger = (_clientOptions$logger = clientOptions === null || clientOptions === void 0 ? void 0 : clientOptions.logger) !== null && _clientOptions$logger !== void 0 ? _clientOptions$logger : createConsoleLogger("warn");
 	return new DefaultConfigDirectorClient(new ReactNativeTelemetryClient(clientSdkKey, (clientOptions === null || clientOptions === void 0 || (_clientOptions$connec = clientOptions.connection) === null || _clientOptions$connec === void 0 ? void 0 : _clientOptions$connec.url) ? urlFactory(clientOptions.connection.url) : CLIENT_BASE_URL, logger, urlFactory), clientSdkKey, {
 		sdkName: "react-native-sdk",
-		sdkVersion: "0.1.0"
+		sdkVersion: "0.1.1"
 	}, {
 		...clientOptions,
 		logger

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@configdirector/react-native-sdk",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "React Native client SDK for ConfigDirector. ConfigDirector is a remote configuration and feature flag service.",
   "license": "MIT",
   "author": "ConfigDirector",