Skip to content

Commit d86389f

Browse files
authored
Create README.md
1 parent bc42176 commit d86389f

File tree

1 file changed

+79
-0
lines changed

1 file changed

+79
-0
lines changed

README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# CurrencyEditText
2+
3+
An Android EditText with automatic currency formatting.
4+
5+
---
6+
7+
## Releases:
8+
9+
#### Current release: 1.0.0.
10+
11+
You can see all the library releases [here](https://github.com/marcoscgdev/CurrencyEditText/releases).
12+
13+
---
14+
15+
## Screenshots
16+
<kbd><img src="https://raw.githubusercontent.com/marcoscgdev/CurrencyEditText/master/Screenshot_1617663066.png" width="350"></kbd>&nbsp;&nbsp;&nbsp;&nbsp;<kbd><img src="https://raw.githubusercontent.com/marcoscgdev/CurrencyEditText/master/Screenshot_1617663115.png" width="350"></kbd>
17+
18+
Download the sample apk [here](https://github.com/marcoscgdev/CurrencyEditText/releases/download/1.0.0/app-debug.apk).
19+
20+
---
21+
22+
## Usage:
23+
24+
### Adding the depencency
25+
26+
Add this to your root *build.gradle* file:
27+
28+
```groovy
29+
allprojects {
30+
repositories {
31+
...
32+
maven { url 'https://jitpack.io' }
33+
}
34+
}
35+
```
36+
37+
Now add the dependency to your app build.gradle file:
38+
39+
```groovy
40+
implementation 'com.github.marcoscgdev:CurrencyEditText:1.0.0'
41+
```
42+
43+
### Using the widget
44+
45+
```xml
46+
<com.marcoscg.currencyedittext.CurrencyEditText
47+
android:id="@+id/editText"
48+
android:layout_width="match_parent"
49+
android:layout_height="wrap_content" />
50+
```
51+
52+
### Retrieving the value
53+
54+
```kotlin
55+
val value = currencyEditText.getNumericValue()
56+
```
57+
58+
---
59+
>See the *sample project* to clarify any queries you may have.
60+
61+
---
62+
63+
## License
64+
65+
```
66+
Copyright 2021 Marcos Calvo García
67+
68+
Licensed under the Apache License, Version 2.0 (the "License");
69+
you may not use this file except in compliance with the License.
70+
You may obtain a copy of the License at
71+
72+
http://www.apache.org/licenses/LICENSE-2.0
73+
74+
Unless required by applicable law or agreed to in writing, software
75+
distributed under the License is distributed on an "AS IS" BASIS,
76+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
77+
See the License for the specific language governing permissions and
78+
limitations under the License.
79+
```

0 commit comments

Comments
 (0)