docs/example-usage (#13)

* docs: updated readme with example usage

* fix: requested changes

Author: SikoraKam

README.md

@@ -1,47 +1,109 @@
 # @swmansion/react-native-detour
 
-sdk for handling deferred links
+SDK for handling deferred links in react native
 
 ## Installation
 
+npm:
+
 ```sh
 npm install @swmansion/react-native-detour
 ```
 
+yarn:
+
+```sh
+yarn add @swmansion/react-native-detour
+```
+
+pnpm:
+
+```sh
+pnpm add @swmansion/react-native-detour
+```
+
+bun:
+
+```sh
+bun add @swmansion/react-native-detour
+```
+
 #### You need to install additional dependencies
 
+npm:
+
 ```sh
 npm install expo-localization react-native-device-info expo-clipboard @react-native-async-storage/async-storage expo-application
 ```
 
+yarn:
+
+```sh
+yarn add expo-localization react-native-device-info expo-clipboard @react-native-async-storage/async-storage expo-application
+```
+
+pnpm:
+
+```sh
+pnpm add expo-localization react-native-device-info expo-clipboard @react-native-async-storage/async-storage expo-application
+```
+
+bun:
+
+```sh
+bun add expo-localization react-native-device-info expo-clipboard @react-native-async-storage/async-storage expo-application
+```
+
 ## Usage
 
 #### Initialize provider in root of your app
 
 ```js
 import { DetourProvider, type Config } from '@swmansion/react-native-detour';
 
-export default function App() {
-  const config: Config = {
-    API_KEY: 'ssss-ssss-ssss',
-    appID: 'app-id-from-dashboard',
-    shouldUseClipboard: true,
-  };
+const config: Config = {
+  API_KEY: '<REPLACE_WITH_YOUR_API_KEY>',
+  appID: '<REPLACE_WITH_APP_ID_FROM_PLATFORM>',
+  shouldUseClipboard: true,
+};
+
+export default function RootLayout() {
 
   return(
     <DetourProvider config={config}>
-    // rest of app content
+      <RootNavigator />
     </DetourProvider>)
 }
 ```
 
-#### Use values from context
+#### Example usage with Expo Router
 
 ```js
 import { useDetourContext } from '@swmansion/react-native-detour';
+import * as SplashScreen from 'expo-splash-screen';
+import { Redirect, Stack } from 'expo-router';
+
+SplashScreen.preventAutoHideAsync();
 
-// inside component
-const { deferredLink, deferredLinkProcessed, route } = useDetourContext();
+export function RootNavigator() {
+  const { deferredLinkProcessed, deferredLink, route } = useDetourContext();
+
+  useEffect(() => {
+    if (deferredLinkProcessed) {
+      SplashScreen.hide();
+    }
+  }, [deferredLinkProcessed]);
+
+  if (!deferredLinkProcessed) {
+    return null;
+  }
+
+  if (route) {
+    return <Redirect href={route} />;
+  }
+
+  return <Stack />;
+}
 ```
 
 ## Types
@@ -97,16 +159,6 @@ export type DeferredLinkContext = {
   };
 ```
 
-## Contributing
-
-- [Development workflow](CONTRIBUTING.md#development-workflow)
-- [Sending a pull request](CONTRIBUTING.md#sending-a-pull-request)
-- [Code of conduct](CODE_OF_CONDUCT.md)
-
-## License
-
-MIT
-
 ---
 
 Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)