diff --git a/README.md b/README.md new file mode 100644 index 0000000..cf1f099 --- /dev/null +++ b/README.md @@ -0,0 +1,45 @@ +# Card Slide ![phase](https://camo.githubusercontent.com/cfcaf3a99103d61f387761e5fc445d9ba0203b01/68747470733a2f2f7472617669732d63692e6f72672f6477796c2f657374612e7376673f6272616e63683d6d6173746572) [![](https://jitpack.io/v/Lucem-Anb/CardSlide.svg)](https://jitpack.io/#Lucem-Anb/CardSlide) +This is a twitched animation that slides view from any side of the screen with a card effect +This library extends `View` and adopts all methods used by the `FrameLayout` + +### Illustration +![Card Slide Preview](https://anbinsane.files.wordpress.com/2018/07/gif-first.gif) + +### Implementation +add this dependancy line in your build.gradle **app level** + +` //to add//` + +### Usage +Wrap your view with the class `SliderAnimate` + +``` + + + + + + +``` + +Initialize the animation in your java class + +`findViewById(R.id.slider_animate).startSlide()` + + +### Customisation + +Define the starting point of the animation + +in design: `app:start="top_left"` + +in activity: `animate.setStartPoint(SliderAnimate.TOP_LEFT);`