Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
taflanidi committed Apr 10, 2023
1 parent 99e153a commit 4972e87
Showing 1 changed file with 21 additions and 20 deletions.
41 changes: 21 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

[![Android Arsenal](https://img.shields.io/badge/Android%20Arsenal-Input%20Mask-brightgreen.svg?style=for-the-badge)](https://android-arsenal.com/details/1/4642) [![](https://img.shields.io/jitpack/version/com.redmadrobot/input-mask-android?style=for-the-badge)](https://jitpack.io/#RedMadRobot/input-mask-android) [![Awesome](https://img.shields.io/badge/-mentioned_in_awesome_android-CCA6C4.svg?colorA=CCA6C4&colorB=261120&logoWidth=20&logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPHN2ZyB3aWR0aD0iMjAiIGhlaWdodD0iMTAiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyI%2BICAgIDxwYXRoIGZpbGw9IiMyNjExMjAiIGQ9Ik0xOS4xNCA0LjVMMTQuMjMgMGwtLjY5Ljc1IDQuMDkgMy43NUgxLjUxTDUuNi43NSA0LjkxIDAgMCA0LjV2Mi45N0MwIDguODEgMS4yOSA5LjkgMi44OCA5LjloMy4wM2MxLjU5IDAgMi44OC0xLjA5IDIuODgtMi40M1Y1LjUyaDEuNTd2MS45NWMwIDEuMzQgMS4yOSAyLjQzIDIuODggMi40M2gzLjAzYzEuNTkgMCAyLjg4LTEuMDkgMi44OC0yLjQzbC0uMDEtMi45N3oiLz48L3N2Zz4%3D&style=for-the-badge)](https://github.com/JStumpp/awesome-android) [![Telegram](https://img.shields.io/badge/-telegram_author-red?color=blue&logo=telegram&style=for-the-badge)](https://t.me/jeorge_taflanidi) [![license](https://img.shields.io/github/license/mashape/apistatus.svg?style=for-the-badge)](#license)

Input masks restrict data input and allow you to guide users to enter correct values.
Check out our [wiki](https://github.com/RedMadRobot/input-mask-android/wiki) for quick start and further reading.

## ⚙️ Features

- Apply formatting to your text fields, see [examples](#examples)
- Filter out nonessential symbols (e.g. extract `0123456` from `+1 (999) 012-34-56`)
- For international phone numbers
- guess the country from the entered digits
- apply corresponding value restrictions (e.g. a 🇺🇸US phone will have a format like `+1 201 456-7890`)

<a name="examples" />

Input masks restrict data input and allow you to guide users to enter correct values.
Check out our [wiki](https://github.com/RedMadRobot/input-mask-android/wiki) for quick start and further reading.

## ⚙️ Features

- Apply formatting to your text fields, see [examples](#examples)
- Filter out nonessential symbols (e.g. extract `0123456` from `+1 (999) 012-34-56`)
- For international phone numbers
- guess the country from the entered digits
- apply corresponding value restrictions (e.g. a 🇺🇸US phone will have a format like `+1 201 456-7890`)
- Apply number/currency formatting

<a name="examples" />

## 💳 Examples

- Phone numbers: `+1 ([000]) [000] [00] [00]`
Expand All @@ -24,10 +25,10 @@ Check out our [wiki](https://github.com/RedMadRobot/input-mask-android/wiki) for
- Visa/MasterCard numbers: `[0000] [0000] [0000] [0000]`
- UK IBAN: `GB[00] [____] [0000] [0000] [0000] [00]`

<a name="installation" />

## 🛠️ Installation

<a name="installation" />

## 🛠️ Installation

### Gradle

Make sure you've added Kotlin support to your project.
Expand All @@ -38,7 +39,7 @@ repositories {
}
dependencies {
implementation 'com.redmadrobot:input-mask-android:6.1.0'
implementation 'com.redmadrobot:input-mask-android:7.1.0'
implementation 'org.jetbrains.kotlin:kotlin-stdlib:$latest_version'
}
Expand All @@ -54,7 +55,7 @@ Should you have any questions, please search for closed [issues](https://github.

<a name="knownissues" />

## ❗Known issues
## ❗Known issues

## InputMask vs. `NoClassDefFoundError`

Expand Down Expand Up @@ -135,4 +136,4 @@ These folks rock:

## ♻️ License

The library is distributed under the MIT [LICENSE](https://github.com/RedMadRobot/input-mask-android/blob/master/LICENSE).
The library is distributed under the MIT [LICENSE](https://github.com/RedMadRobot/input-mask-android/blob/master/LICENSE).

0 comments on commit 4972e87

Please sign in to comment.