Skip to content

Commit a33871b

Browse files
committed
Update README.md
1 parent 3d9cfd1 commit a33871b

1 file changed

Lines changed: 76 additions & 0 deletions

File tree

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# UberProgressView
2+
3+
A simple progress animation developed after taking inspiration from the Uber app.
4+
5+
# Demo
6+
![UberProgressView Demo](https://raw.githubusercontent.com/lazysource/uberprogressview/master/UberProgressViewDemo.gif)
7+
8+
# Download
9+
10+
Add this to your root `build.gradle` file
11+
```
12+
allprojects {
13+
repositories {
14+
...
15+
maven { url "https://jitpack.io" }
16+
}
17+
}
18+
```
19+
Add this to your app module's `build.gradle` file
20+
```
21+
dependencies {
22+
compile 'com.github.lazysource:uberprogressview:1.0.0'
23+
}
24+
```
25+
26+
# Usage
27+
28+
In your Layout XML add this
29+
30+
```
31+
<org.lazysource.uberprogressview.UberProgressView
32+
android:layout_width="wrap_content"
33+
android:layout_height="wrap_content"
34+
app:fading_circle_color="@android:color/holo_red_dark"
35+
app:stationary_circle_color="@android:color/holo_red_dark"
36+
app:orbiting_circle_color="@android:color/holo_red_dark"
37+
app:orbiting_circle_radius="6dp"
38+
app:stationary_circle_radius="12dp" />
39+
40+
```
41+
42+
| Property | Description | Format | Default |
43+
|-------------------------|----------------------------------------------------------|-----------|-----------|
44+
| fading_circle_color | Color of the circle that grows and fades. | color | #29B6F6 |
45+
| orbiting_circle_color | Color of the circle that orbit around the central circle.| color | #29B6F6 |
46+
| stationary_circle_color | Color of the stationary circle in the center. | color | #29B6F6 |
47+
| orbiting_circle_radius | Radius of the orbiting circles. | dimension | 2dp |
48+
| stationary_circle_radius| Radius of the stationary circle in the center. | dimension | 4dp |
49+
50+
51+
# Design Inspiration
52+
53+
Uber App
54+
55+
# Developers
56+
57+
* [Ishan Khanna](https://github.com/ishan1604)
58+
59+
# License
60+
61+
```
62+
Copyright 2015 Ishan Khanna
63+
64+
Licensed under the Apache License, Version 2.0 (the "License");
65+
you may not use this file except in compliance with the License.
66+
You may obtain a copy of the License at
67+
68+
http://www.apache.org/licenses/LICENSE-2.0
69+
70+
Unless required by applicable law or agreed to in writing, software
71+
distributed under the License is distributed on an "AS IS" BASIS,
72+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
73+
See the License for the specific language governing permissions and
74+
limitations under the License.
75+
76+
```

0 commit comments

Comments
 (0)