Skip to content

Commit 674855f

Browse files
authored
Update README.md
1 parent 0ec1c07 commit 674855f

File tree

1 file changed

+54
-33
lines changed

1 file changed

+54
-33
lines changed

README.md

Lines changed: 54 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,80 @@
11
# **Flurry The Carousel**
22
Simple Android library, which can serve as Image Slider too !
33

4-
# Table of Contents
4+
## Table of Contents
55
[Gradle dependecy](#gradledependency)
6-
[How to integrate ?](#Header)
7-
[Adding Flurry to Layout](#FlurryXml)
8-
[Adding Flurry to Java File](#Header)
9-
[Check the latest version](#latestVersion)
10-
[How to integrate ?](#Header)
11-
[How to integrate ?](#Header)
12-
[Flurry step by step gradle integration for newbies to gradle](#stepbystepgradle)
6+
[Usage](#usage)
7+
[Check the latest Version](#latestVersion)
8+
[Flurry step by step gradle integration for gradle beginners](#stepbystepgradle)
139

1410

1511

1612
<a name="gradledependency"/>
1713

18-
## **Gradle Dependency**
19-
### `compile 'com.github.rohitksingh:Flurry:1.0.2`
14+
## **Gradle:**
15+
`
16+
compile 'com.github.rohitksingh:Flurry:1.0.2
17+
`
2018

2119
<a name="Header"/>
2220

23-
## **How to integrate ?**
24-
If you are already familiar with gradle
21+
### **How to integrate ?**
22+
If you are already familiar with gradle. Add the following code in your root build.gradle .
23+
If you are new to gradle see below [Step by step integration guide](#stepbystepgradle) .
2524

26-
Just Add the following code in your root build.gradle . If you are new to gradle see below
27-
[Step by step integration guide](#stepbystepgradle) .
25+
> build.gradle
2826
29-
`allprojects {
27+
allprojects {
3028
repositories {
3129
...
3230
maven { url 'https://jitpack.io' }
3331
}
3432
}
3533

36-
dependencies {
37-
compile 'com.github.User:Repo:Tag'
38-
}`
34+
> build.gradle
35+
36+
dependencies {
37+
compile 'com.github.rohitksingh:Flurry:1.0.2'
38+
}
39+
40+
<a name="usage"/>
41+
42+
## **Usage:**
43+
44+
### **Add following code in your layout**
45+
46+
<com.rohksin.flurry.Flurry
47+
android:id="@+id/flurry"
48+
android:layout_width="match_parent"
49+
android:layout_height="match_parent"/>
50+
51+
### **Add following code in your Activity**
52+
53+
@Override
54+
protected void onCreate(Bundle savedInstanceState) {
55+
super.onCreate(savedInstanceState);
56+
setContentView(R.layout.activity_main);
57+
58+
59+
Flurry flurry = (Flurry)findViewById(R.id.flurry);
60+
61+
}
62+
63+
<a name ="latestVersion"/>
64+
65+
## **Check the latest Version:**
66+
67+
You can find the latest version of Flurry in [JitPack.io](https://jitpack.io/#rohitksingh/Flurry-The-Carousel)
68+
3969
<a name= "stepbystepgradle"/>
40-
## **Step by step guide to integrate Flurry dependency in gradle file (For Beginners to Gradle)**
4170

42-
#### **1) Go to your root build.gradle**
71+
## **Flurry step by step gradle integration for gradle beginners:**
72+
73+
### **1) Go to your root build.gradle**
4374

4475
??????Image ??????
4576

46-
#### **2) Add repository link and dependency like this**
77+
### **2) Add repository link and dependency like this**
4778

4879

4980

@@ -58,25 +89,15 @@ dependencies {
5889
compile 'com.github.User:Repo:Tag'
5990
}
6091

61-
#### **3) Finally your build.gradle file will look like this**
92+
### **3) Finally your build.gradle file will look like this**
6293

6394
??????? Image
6495

65-
#### **4) Hit the sync Button**
96+
### **4) Hit the sync Button**
6697

6798
And you are done
6899

69100

70101

71-
<a name= "FlurryXml"/>
72-
Adding Flurry to Layout (xml)
73102

74-
`<com.rohksin.flurry.Flurry
75-
android:id="@+id/flurry"
76-
android:layout_width="match_parent"
77-
android:layout_height="300dp"/>`
78103

79-
<a name ="latestVersion"/>
80-
## **Check the latest Version**
81-
82-
[JitPack.io](https://jitpack.io/#rohitksingh/Flurry-The-Carousel)

0 commit comments

Comments
 (0)