Update README.md

Author: SameerArora497

README.md

@@ -16,13 +16,13 @@ yarn add react-native-install-referrer
 
 ### Android
 
-No manual linking needed (auto-linked). The library adds `com.android.installreferrer:installreferrer:2.2` to your Android build automatically via `build.gradle`.
+No manual linking needed (auto-linked). The library adds `com.android.installreferrer:installreferrer:2.2` to your Android build automatically.
 
 Make sure Google Play Store is installed on the test device — the API is backed by a Play Store service.
 
 ### iOS
 
-No additional setup needed. All methods return `null` on iOS. Check for `null` before using results.
+No additional setup needed. All methods return `null` on iOS. Always null-check before using results.
 
 ---
 
@@ -48,7 +48,7 @@ const details = await getReferrerDetails();
 //   instantExperience: false,
 // }
 
-// Parse UTM parameters
+// Parse UTM parameters from the referrer string
 const utm = parseReferrer(referrer ?? '');
 // { utm_source: 'google', utm_medium: 'cpc', utm_campaign: 'launch' }
 ```
@@ -59,42 +59,40 @@ const utm = parseReferrer(referrer ?? '');
 
 ### `getInstallReferrer(): Promise<string | null>`
 
-Returns the raw install referrer string as provided by Google Play.
+Returns the raw install referrer string from Google Play.
 
-- **Android** — Resolves with the referrer string (empty string `""` if no referrer was set).
+- **Android** — Resolves with the referrer string. Returns `""` if no referrer was set.
 - **iOS** — Resolves with `null`.
-- **Throws** — Rejects with a standardized error code (see [Error Codes](#error-codes)) on failure.
+- **Throws** — Rejects with a standardized error code on failure (see [Error Codes](#error-codes)).
 
-Results are **cached** after the first successful call — subsequent calls return immediately without a native round-trip.
+Result is **cached** after the first successful call — subsequent calls return immediately without a native round-trip.
 
 ---
 
 ### `getReferrerDetails(): Promise<ReferrerDetails | null>`
 
-Returns the full referrer details object.
+Returns full referrer details including timestamps and instant-experience flag.
 
 ```ts
 type ReferrerDetails = {
   referrer: string;
-  /** Unix timestamp in milliseconds */
-  clickTimestamp: number;
-  /** Unix timestamp in milliseconds */
-  installTimestamp: number;
+  clickTimestamp: number;    // Unix timestamp in milliseconds
+  installTimestamp: number;  // Unix timestamp in milliseconds
   instantExperience: boolean;
 };
 ```
 
-- **Android** — Resolves with the full details.
+- **Android** — Resolves with the full details object.
 - **iOS** — Resolves with `null`.
 - **Throws** — Rejects with a standardized error code on failure.
 
-Results are **cached** after the first successful call.
+Result is **cached** after the first successful call.
 
 ---
 
 ### `parseReferrer(referrer: string): Record<string, string>`
 
-Parses a URL-encoded referrer string into a plain key/value object. Handles percent-encoding and `+`-as-space correctly.
+Parses a URL-encoded referrer string into a plain key/value object. Handles percent-encoding and `+`-as-space.
 
 ```ts
 parseReferrer('utm_source=google&utm_medium=cpc&utm_campaign=Q4+launch');
@@ -103,28 +101,22 @@ parseReferrer('utm_source=google&utm_medium=cpc&utm_campaign=Q4+launch');
 
 ---
 
-### `clearCache(): void`
-
-Clears the in-memory cache so the next call to `getInstallReferrer` or `getReferrerDetails` fetches fresh data from native. Useful in tests.
-
----
-
 ## Error Codes
 
-When a native call fails, the Promise is rejected with an `Error` whose `code` property is one of:
+When a native call fails the Promise is rejected. The error `code` will be one of:
 
 | Code | Cause |
 |---|---|
-| `SERVICE_UNAVAILABLE` | Play Store is not installed, or the referrer service is unavailable / disconnected |
+| `SERVICE_UNAVAILABLE` | Play Store is not installed, or the referrer service disconnected |
 | `FEATURE_NOT_SUPPORTED` | The installed Play Store version does not support the Install Referrer API |
 | `UNKNOWN_ERROR` | An unexpected response code was returned |
 
 ```ts
 try {
   const referrer = await getInstallReferrer();
-} catch (e) {
-  if ((e as any).code === 'SERVICE_UNAVAILABLE') {
-    // Handle gracefully — e.g. sideloaded APK, non-Play device
+} catch (e: any) {
+  if (e.code === 'SERVICE_UNAVAILABLE') {
+    // Sideloaded APK or non-Play device — handle gracefully
   }
 }
 ```
@@ -133,26 +125,16 @@ try {
 
 ## Android Notes
 
-- The referrer string is set by Google Play at install time and is only available for **90 days** after installation.
-- Sideloaded APKs (not installed via Play Store) will receive an empty referrer string.
-- The API requires the device to have Google Play Services installed.
-- Timestamps returned by the native API are in **seconds**; this library converts them to **milliseconds** for JavaScript consistency.
+- The referrer string is available for **90 days** after installation.
+- Sideloaded APKs (not installed via Play Store) will return an empty referrer string.
+- Requires Google Play Store to be installed on the device.
+- The native API returns timestamps in **seconds** — this library converts them to **milliseconds** so `new Date(clickTimestamp)` works directly.
 
 ---
 
 ## iOS Limitation
 
-Google Play Install Referrer is an Android-only API. There is no equivalent mechanism on iOS. All methods in this library resolve with `null` on iOS. To attribute iOS installs, use the [SKAdNetwork API](https://developer.apple.com/documentation/storekit/skadnetwork) or a third-party attribution SDK.
-
----
-
-## Example App
-
-See [example/src/App.tsx](example/src/App.tsx) for a complete working example that:
-
-- Fetches the referrer string and full details on mount
-- Displays click/install timestamps as ISO date strings
-- Renders parsed UTM parameters in a list
+Google Play Install Referrer is an Android-only API. All methods in this library resolve with `null` on iOS. For iOS install attribution, refer to [SKAdNetwork](https://developer.apple.com/documentation/storekit/skadnetwork) or a third-party attribution SDK.
 
 ---