@themobilefirstcompany/react-native-data-detector 0.1.0 → 0.1.1

package/CONTRIBUTING.md

@@ -0,0 +1,83 @@
+# Contributing
+
+Thanks for your interest in contributing to `react-native-data-detector`! This guide will help you get started.
+
+## Prerequisites
+
+- Node.js 18+
+- Xcode 15+ (for iOS development)
+- Android Studio (for Android development)
+- CocoaPods
+
+## Getting Started
+
+1. Fork and clone the repository:
+
+   ```bash
+   git clone https://github.com/<your-username>/react-native-data-detector.git
+   cd react-native-data-detector
+   ```
+
+2. Install dependencies:
+
+   ```bash
+   npm install
+   ```
+
+## Project Structure
+
+```
+src/          # TypeScript source (module API and types)
+ios/          # iOS native code (Swift, NSDataDetector)
+android/      # Android native code (Kotlin, ML Kit)
+example/      # Expo example app for manual testing
+```
+
+## Running the Example App
+
+```bash
+cd example
+npm install
+npx pod-install
+npx expo run:ios     # or npx expo run:android
+```
+
+## Development Workflow
+
+- **TypeScript changes** — edit files in `src/`, then run `npm run build`.
+- **Native changes** — edit `ios/` or `android/`, then rebuild the example app.
+
+## Available Scripts
+
+| Script          | Description                        |
+| --------------- | ---------------------------------- |
+| `npm run build` | TypeScript typecheck and compile   |
+| `npm run lint`  | Lint the codebase                  |
+| `npm run test`  | Run tests                          |
+| `npm run clean` | Remove build artifacts             |
+
+## Commit Convention
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/):
+
+- `feat:` — new feature
+- `fix:` — bug fix
+- `docs:` — documentation only
+- `chore:` — maintenance, dependencies
+- `refactor:` — code change that neither fixes a bug nor adds a feature
+- `test:` — adding or updating tests
+
+## Pull Request Process
+
+1. Branch from `main`.
+2. Make your changes and ensure all checks pass (`lint`, `build`, `test`).
+3. Fill out the [PR template](.github/PULL_REQUEST_TEMPLATE.md).
+4. Submit your PR against `main`.
+
+## Code of Conduct
+
+This project is governed by the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
+
+## Reporting Bugs & Requesting Features
+
+Please use the [issue templates](https://github.com/themobilefirstco/react-native-data-detector/issues/new/choose) when opening an issue.

package/README.md

@@ -1,7 +1,13 @@
 # react-native-data-detector
 
+[![npm version](https://img.shields.io/npm/v/@themobilefirstcompany/react-native-data-detector)](https://www.npmjs.com/package/@themobilefirstcompany/react-native-data-detector)
+
 Cross-platform text data detection for React Native. Uses **NSDataDetector** on iOS and **ML Kit Entity Extraction** on Android to detect phone numbers, URLs, emails, dates, and addresses — returning structured results to JavaScript.
 
+<p align="center">
+  <img src="data-detector.png" alt="Data Detector Example" width="500" />
+</p>
+
 ## Features
 
 - **Phone numbers** — Detect and extract phone numbers
@@ -15,7 +21,7 @@ Cross-platform text data detection for React Native. Uses **NSDataDetector** on
 ## Installation
 
 ```bash
-npm install react-native-data-detector
+npm install @themobilefirstcompany/react-native-data-detector
 ```
 
 ### iOS
@@ -31,7 +37,7 @@ The ML Kit entity extraction model (~5.6MB) is downloaded on the user's device a
 ## Usage
 
 ```typescript
-import { detect, downloadModel } from 'react-native-data-detector';
+import { detect, downloadModel } from '@themobilefirstcompany/react-native-data-detector';
 
 // Pre-download the ML Kit model at app startup (Android only, no-op on iOS)
 await downloadModel();

package/android/build.gradle

@@ -20,7 +20,7 @@ android {
 
 dependencies {
   implementation project(':expo-modules-core')
-  implementation "com.google.mlkit:entity-extraction:16.0.0-beta5"
+  implementation "com.google.mlkit:entity-extraction:16.0.0-beta6"
 }
 
 def safeExtGet(prop, fallback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@themobilefirstcompany/react-native-data-detector",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Cross-platform text data detection for React Native. Uses NSDataDetector on iOS and ML Kit Entity Extraction on Android to detect phone numbers, URLs, emails, dates, and addresses.",
   "keywords": [
     "react-native",
@@ -15,13 +15,13 @@
     "address",
     "date"
   ],
-  "homepage": "https://github.com/pablogdcr/react-native-data-detector#readme",
+  "homepage": "https://github.com/themobilefirstco/react-native-data-detector#readme",
   "bugs": {
-    "url": "https://github.com/pablogdcr/react-native-data-detector/issues"
+    "url": "https://github.com/themobilefirstco/react-native-data-detector/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/pablogdcr/react-native-data-detector.git"
+    "url": "git+https://github.com/themobilefirstco/react-native-data-detector.git"
   },
   "license": "MIT",
   "author": "pablogdcr",