Skip to content

Commit

Permalink
Readme, changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
bruno-rocha-movile committed Aug 15, 2016
1 parent 38ab471 commit 570467a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 9 deletions.
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
## 0.1.3
- Added Carthage support
* Change the internal file's structure for CocoaPods

## 0.1.2
- Initial release
* Added CocoaPods support
24 changes: 15 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ErrorKing

[![CI Status](http://img.shields.io/travis/bruno-rocha-movile/ErrorKing.svg?style=flat)](https://travis-ci.org/bruno-rocha-movile/ErrorKing)
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
[![Version](https://img.shields.io/cocoapods/v/ErrorKing.svg?style=flat)](http://cocoapods.org/pods/ErrorKing)
[![License](https://img.shields.io/cocoapods/l/ErrorKing.svg?style=flat)](http://cocoapods.org/pods/ErrorKing)
[![Platform](https://img.shields.io/cocoapods/p/ErrorKing.svg?style=flat)](http://cocoapods.org/pods/ErrorKing)
Expand Down Expand Up @@ -32,19 +33,19 @@ To program what happens when the Empty State's reload button is touched, add thi

```swift
extension MyViewController: ErrorProne {
func errorKingEmptyStateReloadButtonTouched() {
//load my stuff again
errorKing?.errorKingEmptyStateReloadButtonTouched()
}
func errorKingEmptyStateReloadButtonTouched() {
//load my stuff again
errorKing?.errorKingEmptyStateReloadButtonTouched()
}
}
```

Additionally, you can further customize ErrorKing by telling what happens before the empty state screen is displayed:

```swift
func actionBeforeDisplayingErrorKingEmptyState() {
//do something before displaying the empty state screen, like disabling your tableView's scrolling
errorKing?.actionBeforeDisplayingErrorKingEmptyState()
//do something before displaying the empty state screen, like disabling your tableView's scrolling
errorKing?.actionBeforeDisplayingErrorKingEmptyState()
}
```

Expand All @@ -66,10 +67,15 @@ You can see it in action on the Example project.

[![ExampleEmptyState](http://i.imgur.com/Ge4BctQ.png)](http://cocoapods.org/pods/ErrorKing)

## Installation
# Installation

ErrorKing is available through [CocoaPods](http://cocoapods.org). To install
it, simply add the following line to your Podfile:
### Carthage

```ruby
github "kingrocha/ErrorKing" "master"
```

### CocoaPods

```ruby
pod "ErrorKing"
Expand Down

0 comments on commit 570467a

Please sign in to comment.