Skip to content

Commit 5163910

Browse files
authored
Update README.md
1 parent fe3caef commit 5163910

File tree

1 file changed

+71
-4
lines changed

1 file changed

+71
-4
lines changed

README.md

Lines changed: 71 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,72 @@
1-
# otp-code-android-view
1+
# Otp View
22

3-
:) :) :)
4-
5-
[device-2023-07-04-154245.webm](https://github.com/phong016688/otp-code-android-view/assets/37899092/c3d86665-58c2-4b88-b562-430387d35bc3)
3+
> The library using for otp code in Android.
4+
5+
<a href="https://github.com/ericktijerou/koleton/actions"><img src="https://github.com/ericktijerou/koleton/workflows/Build%20and%20test/badge.svg"/>
6+
7+
An Android library that provides an easy enter and verify otp code.
8+
9+
Made with ❤ by [phong](https://github.com/phong016688).
10+
11+
## Installation
12+
You can install `otp-loading-view` with `Maven Central` and `Gradle`:
13+
14+
```gradle
15+
// In your module's `build.gradle`
16+
dependencies {
17+
implementation 'com.github.phong016688:otp-code-android-view:0.1'
18+
}
19+
```
20+
21+
Make sure to include `maven { url 'https://jitpack.io' }` in your repositories
22+
```gradle
23+
repositories {
24+
maven { url 'https://jitpack.io' }
25+
}
26+
```
27+
28+
29+
## Default config:
30+
```
31+
<com.otp.otp_code_view.OtpCodeView
32+
android:layout_width="match_parent"
33+
android:layout_height="wrap_content"
34+
android:layout_marginTop="100dp"/>
35+
```
36+
37+
[video_black.webm](https://github.com/phong016688/otp-code-android-view/assets/37899092/1c8138a9-35c7-4a12-940c-9a8af6c2f409)
38+
39+
## Custom config:
40+
```
41+
<com.otp.otp_code_view.OtpCodeView
42+
android:layout_width="match_parent"
43+
android:layout_height="wrap_content"
44+
app:code_color="#CC171717"
45+
app:code_stroke_color="#185C1F"
46+
app:code_done_stroke_color="#1AA327"
47+
app:code_background_color="#667A7979"
48+
app:code_error_color="#A50202"
49+
app:code_stroke_error_color="#F11919"
50+
app:code_length="4"
51+
app:code_radius="10dp"
52+
app:code_stroke_width="2dp"/>
53+
```
54+
> Note: max length code is 6.
55+
56+
[video_white.webm](https://github.com/phong016688/otp-code-android-view/assets/37899092/44f7077c-95f3-4fc5-b1bf-4c101cb05b77)
57+
58+
## License
59+
60+
Copyright 2020
61+
62+
Licensed under the Apache License, Version 2.0 (the "License");
63+
you may not use this file except in compliance with the License.
64+
You may obtain a copy of the License at
65+
66+
http://www.apache.org/licenses/LICENSE-2.0
67+
68+
Unless required by applicable law or agreed to in writing, software
69+
distributed under the License is distributed on an "AS IS" BASIS,
70+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
71+
See the License for the specific language governing permissions and
72+
limitations under the License.

0 commit comments

Comments
 (0)