react-native-otp-auto-verify 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +10 -26
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -3,41 +3,25 @@
3
3
  <div align="center">
4
4
 
5
5
  [![npm version](https://img.shields.io/npm/v/react-native-otp-auto-verify.svg?style=flat-square)](https://www.npmjs.com/package/react-native-otp-auto-verify)
6
- [![npm downloads](https://img.shields.io/npm/dm/react-native-otp-auto-verify.svg?style=flat-square)](https://www.npmjs.com/package/react-native-otp-auto-verify)
7
- [![license](https://img.shields.io/npm/l/react-native-otp-auto-verify.svg?style=flat-square)](https://github.com/kailas-rathod/react-native-otp-auto-verify/blob/main/LICENSE)
6
+
8
7
  [![typescript](https://img.shields.io/badge/TypeScript-Ready-blue.svg?style=flat-square)](https://www.typescriptlang.org/)
8
+ [![license](https://img.shields.io/npm/l/react-native-otp-auto-verify.svg?style=flat-square)](https://github.com/kailas-rathod/react-native-otp-auto-verify/blob/main/LICENSE)
9
9
 
10
10
  Automatic OTP detection on **Android** using the **Google SMS Retriever API** (no `READ_SMS` permission required).
11
11
 
12
12
  </div>
13
13
 
14
- ## Table of contents
15
-
16
- - [Features](#features)
17
- - [Platform support](#platform-support)
18
- - [Requirements](#requirements)
19
- - [Installation](#installation)
20
- - [Usage](#usage)
21
- - [1) Get your app hash](#1-get-your-app-hash)
22
- - [2) Format your OTP SMS](#2-format-your-otp-sms)
23
- - [3) Hook usage (recommended)](#3-hook-usage-recommended)
24
- - [4) Imperative usage](#4-imperative-usage)
25
- - [API](#api)
26
- - [Timeout behavior](#timeout-behavior)
27
- - [React Native New Architecture](#react-native-new-architecture)
28
- - [Troubleshooting](#troubleshooting)
29
- - [Example app](#example-app)
30
- - [Contributing](#contributing)
31
- - [License](#license)
14
+
32
15
 
33
16
  ## Features
34
17
 
35
- - Automatically extracts **4–6 digit** OTPs from SMS on Android
36
- - Uses Google **SMS Retriever API** (Play Store compliant, **no SMS permissions**)
37
- - Includes a **React hook** and an **imperative** API
38
- - Fully typed (**TypeScript**)
39
- - **React Native New Architecture** (TurboModules) supported
40
- - iOS is a **safe no-op** (manual OTP entry required)
18
+ Automatic SMS Verification with the SMS Retriever API (Android Only)
19
+ Phone Number Retrieving using the Phone Number Hint API (Android Only)
20
+ Automatic SMS Verification with the SMS Retriever API, you can perform SMS-based user verification in your Android app automatically, without requiring the user to manually type verification codes, and without requiring any extra app permissions.
21
+
22
+ Message Format/Structure
23
+ In order to detect the message, SMS message must include a hash that identifies your app. This hash can be obtained by using the getHash() method below.
24
+
41
25
 
42
26
  ## Platform support
43
27
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "react-native-otp-auto-verify",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "react-native-otp-auto-verify is a React Native library for automatic OTP detection and verification on Android using the Google SMS Retriever API. It enables secure, permission-less OTP auto-reading without requiring READ_SMS, making it fully Play Store compliant.",
5
5
  "keywords": [
6
6
  "react-native",