Skip to content

Commit

Permalink
First edit of Readme.md
Browse files Browse the repository at this point in the history
Explanation of the implementation of this library.
  • Loading branch information
sam43 authored Apr 13, 2020
1 parent 1b1ea29 commit e267583
Showing 1 changed file with 75 additions and 0 deletions.
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# SplashApplication
Developing easy to use any animation set or animation list upon a single view or mulltiple views at a time as splash screen in Android application

# Alpha Release
Alpha release of Starter Animation for android application. Feel free to suggest. Thank you

# Features
- Create an Starter/Splash animation with any animation
- Can able to use multiple animation files on a single view.
- Easy implementation for any activity and fragment

# Implementation
- **Step-1: Add the JitPack repository to your build file**
```
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
- **Step-2: Add the dependency**
```
dependencies {
implementation "com.github.sam43:SplashApplication:$latest_version"
}
```
where last release version is the `letest_version`.

- **Step-3: Create list of animations to be applied to**
We will be creating a list of animation like below and pass it to the library with the view, on which the animation will be applied. List of animation method, will be something like this :-
```
private fun getAnimList(): ArrayList<Animation> {
// create list of animations
val animList: ArrayList<Animation> = ArrayList()
val anim = AnimationUtils.loadAnimation(
applicationContext,
R.anim.no_animaiton
)
val anim1 = AnimationUtils.loadAnimation(
applicationContext,
R.anim.rotate
)
.
.
.
animList.add(anim)
animList.add(anim1)
.
.
.
return animList
}
```

- **Step-4: Use the animation list for the library**
Finally, We will be passing the list and implement the listener provided which will notify the application when animations have ended. The implementation will be like below:-
```StarterAnimation(
resList = getAnimList(),
onAnimationListener = object : OnAnimationListener {
override fun onRepeat() {}
override fun onEnd() {
// TODO: Do what you want to do after end of animations
}
override fun onStartAnim() {}
}
).startSequentialAnimation(view = imageView)
```
Well, That's all. Please let me know if you guys have any suggestions. Any suggestion will be appreciated. Thanks


0 comments on commit e267583

Please sign in to comment.