react-native-nitro-country-picker 0.1.0 → 0.1.2

package/README.md

@@ -1,20 +1,30 @@
 # react-native-nitro-country-picker
 
-A native country picker for React Native, powered by Nitro Modules.
+A Promise-based, native country picker for React Native, powered by Nitro Modules.
+
+[![npm version](https://img.shields.io/npm/v/react-native-nitro-country-picker?style=for-the-badge&color=blue)](https://www.npmjs.com/package/react-native-nitro-country-picker)
+[![Monthly downloads](https://img.shields.io/npm/dm/react-native-nitro-country-picker?style=for-the-badge)](https://www.npmjs.com/package/react-native-nitro-country-picker)
+[![New Architecture](https://img.shields.io/badge/New%20Architecture-Ready-5f3dc4?style=for-the-badge)](https://reactnative.dev/docs/the-new-architecture/landing-page)
+[![TypeScript](https://img.shields.io/badge/TypeScript-Supported-3178C6?style=for-the-badge)](https://www.typescriptlang.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-2f9e44?style=for-the-badge)](LICENSE)
+[![iOS](https://img.shields.io/badge/iOS-15.1%2B-000000?style=for-the-badge&logo=apple)](https://developer.apple.com/ios/)
+[![Android](https://img.shields.io/badge/Android-API%2024%2B-3DDC84?style=for-the-badge&logo=android&logoColor=white)](https://developer.android.com/)
+[![Nitro Modules](https://img.shields.io/badge/Nitro%20Modules-Enabled-ff6b00?style=for-the-badge)](https://nitro.margelo.com/)
+
+| Preview 1                                                                    | Preview 2                                                                            |
+| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
+| <img width="350" height="781" alt="iOS Preview" src="./images/cp-ios.png" /> | <img width="350" height="781" alt="Android Preview" src="./images/cp-android.png" /> |
 
 This library provides a single async API that opens a native picker and returns structured country data.
 
+I created this library because I kept running into cases where I needed to implement a country code picker. There are several options, but they are either JS-only solutions with a declarative API (often with poor performance) or noticeably laggy.
+
+All I wanted was a module with a single `pickCountry` method that returns country data. Done. No hassle. The UI should include a list and a simple search bar. It can be customized, but for now it should stay as simple as possible.
+
 - Android native implementation: [CountryCodePickerCompose](https://github.com/ahmmedrejowan/CountryCodePickerCompose)
 - iOS native implementation: [CountryPickerAKS](https://github.com/aksamitsah/CountryPickerAKS)
 
-## Features
-
-- Native picker UI on both iOS and Android
-- Promise-based API: `pickCountry(options?)`
-- Typed result object with `name`, `dialCode`, and `code`
-- `null` result when user dismisses without selection
-- Last selection cache via `getLastPickedCountry()`
-- Optional picker title input: `headerTitle` (currently applied on Android)
+---
 
 ## Requirements
 
@@ -25,6 +35,20 @@ This library provides a single async API that opens a native picker and returns
 
 > Note: This package depends on [react-native-nitro-modules](https://nitro.margelo.com/).
 
+---
+
+## Features
+
+- 📱 **Native UI**: Uses native picker interfaces on both iOS and Android.
+- ⚡ **Promise-Based API**: Call `pickCountry(options?)` and await the result.
+- 🔷 **Typed Return Data**: Returns a typed object with `name`, `dialCode`, and `code`.
+- 🧭 **Dismiss Handling**: Resolves to `null` when the picker is dismissed or canceled.
+- 🧠 **Last Selection Cache**: Read the last picked country with `getLastPickedCountry()`.
+- 🎛️ **Configurable Title**: Supports `headerTitle` (currently applied on Android).
+- 🧩 **Nitro Module Powered**: Built with `react-native-nitro-modules` for native performance.
+
+---
+
 ## Installation
 
 ```bash
@@ -37,12 +61,18 @@ or
 yarn add react-native-nitro-country-picker react-native-nitro-modules
 ```
 
-### iOS setup
+### iOS Setup
 
 ```bash
 cd ios && pod install
 ```
 
+### Android Setup
+
+No additional configuration is required for Android. Autolinking handles the native module setup.
+
+---
+
 ## Usage
 
 ```tsx
@@ -61,6 +91,8 @@ const country = await pickCountry({
 });
 ```
 
+---
+
 ## Returned Data Examples
 
 ### 1) Handle selected vs dismissed
@@ -108,6 +140,8 @@ if (last) {
 }
 ```
 
+---
+
 ## API
 
 ### `pickCountry(options?) => Promise<IPickedCountry | null>`
@@ -125,6 +159,8 @@ Options:
 
 Returns the most recent selected country for the current app runtime session.
 
+---
+
 ## Type Shapes
 
 ```ts
@@ -139,6 +175,8 @@ type PickCountryOptions = {
 };
 ```
 
+---
+
 ## Example App
 
 To run the included example app:
@@ -151,10 +189,14 @@ yarn ios
 yarn android
 ```
 
+---
+
 ## Contributing
 
 See [CONTRIBUTING.md](CONTRIBUTING.md) for development workflow and contribution guidelines.
 
+---
+
 ## License
 
 MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-nitro-country-picker",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Native country picker module, powered by NitroModules",
   "main": "./lib/module/index.js",
   "types": "./lib/typescript/src/index.d.ts",
@@ -84,7 +84,7 @@
     "react": "19.2.4",
     "react-native": "0.84.1",
     "react-native-builder-bob": "^0.41.0",
-    "react-native-nitro-modules": "^0.35.3",
+    "react-native-nitro-modules": "0.35.3",
     "release-it": "^19.2.4",
     "turbo": "^2.9.3",
     "typescript": "^6.0.2"
@@ -92,7 +92,7 @@
   "peerDependencies": {
     "react": "*",
     "react-native": "*",
-    "react-native-nitro-modules": "^0.26.4"
+    "react-native-nitro-modules": "0.35.3"
   },
   "workspaces": [
     "example"