docs: add Docusaurus configuration and update package.json for documentation support

Author: AlshehriAli0

.github/workflows/docs.yml

@@ -0,0 +1,49 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "docs/**"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        working-directory: docs
+        run: bun install --frozen-lockfile
+
+      - name: Build docs
+        working-directory: docs
+        run: bun run build
+
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -63,3 +63,7 @@ lib/
 .eslintcache
 .cache
 *.tsbuildinfo
+
+# Docusaurus
+docs/.docusaurus/
+docs/build/

README.md

@@ -12,105 +12,42 @@
 
 <br />
 
-## Features
-
-- ⚡ **Synchronous access** to version, build number, package name, and country
-- 🏪 **Store version lookup** from the App Store or Play Store
-- 🔍 **Granular update checks** — major, minor, or patch
-- 📦 **Install source detection** — TestFlight, App Store, Play Store, or sideloaded
-- 🪶 **Tiny footprint** — pure Swift on iOS, Kotlin on Android
-
-## Performance
-
-Benchmarked against [`react-native-version-check`](https://github.com/kimxogus/react-native-version-check). 100,000 iterations averaged over 5 runs on an iPhone 12:
-
-| Method | Speedup |
-|--------|---------|
-| `getAllInfo` | **~3.1x faster** |
-| `packageName` | **~1.6x faster** |
-| `version` | **~1.6x faster** |
-| `buildNumber` | **~1.6x faster** |
-| `getCountry` | **~3.1x faster** |
-
-## Installation
-
-```sh
-bun add react-native-nitro-version-check react-native-nitro-modules
-```
-
-For Expo projects, run prebuild:
-```sh
-npx expo prebuild
-```
-
-For bare React Native projects:
-```sh
-cd ios && pod install
-```
-
-## Usage
+## Example
 
 ```ts
-import { VersionCheck, getCountry, getStoreUrl, getLatestVersion, needsUpdate } from 'react-native-nitro-version-check'
+import { VersionCheck, needsUpdate, getStoreUrl } from 'react-native-nitro-version-check'
 
-// Sync properties
+// Sync — no bridge, no async
 VersionCheck.version       // "1.2.0"
 VersionCheck.buildNumber   // "42"
 VersionCheck.packageName   // "com.example.app"
 VersionCheck.installSource // "appstore" | "testflight" | "playstore" | undefined
-getCountry()               // "US"
-
-// Async
-const url    = await getStoreUrl()       // App Store / Play Store URL
-const latest = await getLatestVersion()  // "1.3.0"
 
+// Check for updates
 if (await needsUpdate()) {
   Linking.openURL(await getStoreUrl())
 }
-
-// Only prompt for major updates
-if (await needsUpdate({ level: 'major' })) {
-  // 1.x → 2.x
-}
 ```
 
-## API
-
-### `VersionCheck`
-
-| Property | Type | Description |
-|----------|------|-------------|
-| `version` | `string` | App version |
-| `buildNumber` | `string` | Build number |
-| `packageName` | `string` | Bundle ID / Application ID |
-| `installSource` | `string \| undefined` | `"appstore"` `"testflight"` `"playstore"` or `undefined` |
-| `getCountry()` | `string` | Device's 2-letter ISO country code |
-| `getStoreUrl()` | `Promise<string>` | App Store / Play Store URL |
-| `getLatestVersion()` | `Promise<string>` | Latest version in the store |
-| `needsUpdate()` | `Promise<boolean>` | Whether an update is available |
-
-### Standalone exports
-
-Also available as individual named exports:
+## Installation
 
-| Export | Returns | Description |
-|--------|---------|-------------|
-| `getCountry()` | `string` | Device's 2-letter ISO country code |
-| `getStoreUrl()` | `Promise<string>` | App Store / Play Store URL |
-| `getLatestVersion()` | `Promise<string>` | Latest version in the store |
-| `needsUpdate(options?)` | `Promise<boolean>` | Whether an update is available |
+Install [react-native-nitro-version-check](https://npmjs.org/react-native-nitro-version-check) from npm:
+```sh
+bun add react-native-nitro-version-check react-native-nitro-modules
+cd ios && pod install
+```
 
-#### `needsUpdate` options
+## Documentation
 
-| Option | Type | Default | Description |
-|--------|------|---------|-------------|
-| `level` | `"major" \| "minor" \| "patch"` | `"patch"` | Minimum version bump to trigger `true` |
+- [**Nitro Version Check** docs 📚](https://alshehriali0.github.io/react-native-nitro-version-check/)
+- [**Getting Started** guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/getting-started)
+- [**Installation** guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/installation)
+- [**API Reference**](https://alshehriali0.github.io/react-native-nitro-version-check/docs/api-reference)
+- [**Migration Guide** from react-native-version-check](https://alshehriali0.github.io/react-native-nitro-version-check/docs/migration-guide)
 
-### Utilities
+## Contributing
 
-| Function | Returns | Description |
-|----------|---------|-------------|
-| `compareVersions(v1, v2)` | `-1 \| 0 \| 1` | Compare two semver strings |
+See the [contributing guide](https://alshehriali0.github.io/react-native-nitro-version-check/docs/contributing) to learn how to contribute to the repository and the development workflow.
 
 ## License