diff --git a/README.md b/README.md index 5e7ee90..300368f 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@ -# react-native-advanced-input-mask +# React Native Advanced Input Mask -Text input mask for React Native on iOS and Android. +`react-native-advanced-input-mask` is a customizable input masking library for React Native applications. It allows you to create formatted input fields with ease, supporting a variety of input types such as phone numbers, dates, and more. The package leverages advanced masking features to improve user input experiences, making form data entry more consistent and intuitive. + +## Features +- Flexible and customizable input masks. +- Easy integration with React Native components. +- Supports various types of formatted inputs (e.g., phone numbers, credit cards, dates). +- Works seamlessly across Android and iOS platforms. ## Installation -```sh +### Using npm: +```bash npm install react-native-advanced-input-mask ``` -## Usage - -```js -import { multiply } from 'react-native-advanced-input-mask'; - -// ... - -const result = await multiply(3, 7); +### Using Yarn: +```bash +yarn add react-native-advanced-input-mask ``` ## Contributing