Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
andreamazz committed Aug 14, 2015
1 parent a5790db commit 9425694
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

[![Build Status](https://travis-ci.org/andreamazz/AMWaveTransition.png)](https://travis-ci.org/andreamazz/AMWaveTransition)
[![Cocoapods](https://cocoapod-badges.herokuapp.com/v/AMWaveTransition/badge.png)](http://cocoapods.org/?q=amwavetransition)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Flattr](http://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/thing/2977459/andreamazzAMWaveTransition-on-GitHub)

Custom transition between viewcontrollers holding tableviews. Each cell is animated to simulate a 'wave effect'.
Expand All @@ -14,20 +15,19 @@ Read more about transitions [here](http://andreamazz.github.io/blog/2014/04/19/t

![AMWaveTransition](https://raw.githubusercontent.com/andreamazz/AMWaveTransition/master/assets/screenshot.gif)

Getting Started
=================
#Getting Started

###Install
##Install

* Add ```pod 'AMWaveTransition'``` to your [Podfile](http://cocoapods.org/)
* Run ```pod install```
* Run ```open App.xcworkspace```

###Setup as superclass
##Setup as superclass

* Subclass ```AMWaveViewController``` and override ```visibleCells``` or follow these steps:

###Setup manually
##Setup manually

Implement ```UINavigationControllerDelegate``` and this delegate method:
```objc
Expand Down Expand Up @@ -65,7 +65,7 @@ Implement th ```AMWaveTransitioning``` protocol by returning your tableview's vi
}
```

###Interactive gesture
##Interactive gesture

To implement the interactive gesture create a new property in your view controller:
```objc
Expand Down Expand Up @@ -95,11 +95,11 @@ If the view controller you are transitioning to has no table view, don't impleme
As you can see in the sample project, the best results are obtained by setting the view and the cells' background to ```clearColor```, and setting a background color or a background image to the navigation controller.


###MIT License
#MIT License

The MIT License (MIT)

Copyright (c) 2014 Andrea Mazzini
Copyright (c) 2015 Andrea Mazzini

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
Expand Down

0 comments on commit 9425694

Please sign in to comment.