Skip to content

Commit b7015f5

Browse files
committed
Updated README.md
1 parent d6afe34 commit b7015f5

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

.idea/misc.xml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
## Setup
66

7-
#### Step 1. Add the JitPack repository to your build file
7+
#### Step 1. Add the JitPack repository to your build file
8+
89
>**Add it in your root build.gradle at the end of repositories:**
910
1011
```
@@ -15,7 +16,9 @@ allprojects{
1516
}
1617
}
1718
```
19+
1820
#### Step 2. Add the dependency
21+
1922
```
2023
dependencies {
2124
...
@@ -24,6 +27,7 @@ dependencies {
2427
```
2528

2629
#### Using maven:
30+
2731
```
2832
<repositories>
2933
<repository>
@@ -32,8 +36,10 @@ dependencies {
3236
</repository>
3337
</repositories>
3438
```
39+
3540
#### Step 2. Add the dependency
36-
```
41+
42+
```markdown
3743
<dependency>
3844
<groupId>com.github.amitjangid80</groupId>
3945
<artifactId>multiutillib</artifactId>
@@ -42,7 +48,9 @@ dependency>
4248
```
4349

4450
## Usage
51+
4552
### ProjectApplication Class
53+
4654
>**You can create an Application class for your project if you want and set up some utils there.**
4755
4856
```java
@@ -245,6 +253,7 @@ dbHelper.getRecordCount(tableName, values, hasConditions, conditionalValues);
245253
```
246254

247255
### SquareImageView
256+
248257
>**Use it the way you use ImageView in android. This makes your image in a perfect square shape.**
249258
250259
```xml
@@ -258,6 +267,7 @@ dbHelper.getRecordCount(tableName, values, hasConditions, conditionalValues);
258267

259268

260269
### CircularImageView
270+
261271
>**Use it the way you use ImageView in android. Attributes for this image view are as follows:**
262272
263273
**1. highlightEnable - true/false**
@@ -284,6 +294,7 @@ dbHelper.getRecordCount(tableName, values, hasConditions, conditionalValues);
284294
```
285295

286296
### AvatarImageView
297+
287298
>**Use it the way you use ImageView in android. Attributes for this image view are as follows:**
288299
289300
**1. imgStrokeWidth**
@@ -319,6 +330,7 @@ dbHelper.getRecordCount(tableName, values, hasConditions, conditionalValues);
319330
```
320331

321332
### TouchImageView
333+
322334
>**Use it the way you use ImageView in android. This is helpful when you have to add zoom in or zoom out functionality to the imageView with additional code.**
323335
324336

@@ -331,10 +343,12 @@ dbHelper.getRecordCount(tableName, values, hasConditions, conditionalValues);
331343
```
332344

333345
### SwitchButton
346+
334347
>**Use it in the xml file like this.**
335348
336349
**If you are using typeface then add the font file into assets folder, inside assets folder create another folder named 'fonts'. And then just use the name of your font file like the one in below example.**
337350

351+
**UI Part**
338352
```xml
339353
<com.amit.ui.SwitchButton
340354
android:id="@+id/switchButton"
@@ -351,6 +365,8 @@ dbHelper.getRecordCount(tableName, values, hasConditions, conditionalValues);
351365
app:typeface="QuattrocentoSans-Regular.ttf" />
352366
```
353367

368+
**Java code**
369+
354370
```java
355371
// the below code shows how to use the SwitchButton to get the selected values.
356372
SwitchButton switchButton = findViewById(R.id.switchButton);
@@ -451,6 +467,7 @@ private class GeocoderHandler extends Handler
451467
```
452468

453469
### FontHelper Class
470+
454471
>**This class helps you to apply the font to the entire layout file. This file will apply the required font to every view of the layout file.**
455472
456473
```java
@@ -459,6 +476,7 @@ FontHelper.applyFont(context, idOfYourParentLayout, "fonts/QuattrocentoSans-Regu
459476
```
460477

461478
### InternetConection class
479+
462480
>**This class will help you check if internet connection is available or not.**
463481
464482
```java
@@ -486,6 +504,7 @@ TextUtilities.replaceTrueOrFalse(string); // this will return int value.
486504
```
487505

488506
### Validator class
507+
489508
>**This class helps you to validate some common fields like email, mobile number, numbers only, etc.**
490509
491510
```java

0 commit comments

Comments
 (0)