Skip to content

Commit

Permalink
feat: add simple documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
IvanIhnatsiuk committed Oct 16, 2024
1 parent 0e2ba78 commit a9a586c
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit a9a586c

Please sign in to comment.