Skip to content
This repository has been archived by the owner on Dec 22, 2023. It is now read-only.

Commit

Permalink
Update README with images and credits
Browse files Browse the repository at this point in the history
  • Loading branch information
zenangst committed Feb 13, 2018
1 parent 1b197c6 commit 5bfdd64
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 1 deletion.
Binary file added Images/Family-header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/Family-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added Images/Family-illustration.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
# Family
![Family logo](https://raw.githubusercontent.com/zenangst/Family/master/Images/Family-header.png)
<div align="center">

[![CI Status](https://img.shields.io/circleci/project/github/zenangst/Family.svg)](https://circleci.com/gh/zenangst/Family)
[![Version](https://img.shields.io/cocoapods/v/Family.svg?style=flat)](http://cocoadocs.org/docsets/Family)
Expand All @@ -9,11 +10,15 @@

## Description

<img src="https://raw.githubusercontent.com/zenangst/Family/master/Images/Family-icon.png" alt="Family Icon" align="right" />

Family is a child view controller framework that makes setting up your parent controllers as easy as pie.
With a simple yet powerful public API, you can build complex layout without losing maintainability. Leaving you to focus on what matters, making your applications pop and your business logic shine.

## Why

<img src="https://raw.githubusercontent.com/zenangst/Family/master/Images/Family-illustration.jpg" alt="Family Illustration" align="right" />

This framework was built to make it easier to build and maintain parent controllers, or made famous by other in the industry as flow controllers. Using child view controllers can make your code more modular, flexible and testable. There are just some shortcoming with the vanilla approach when dealing with child view controllers.

How do you get a continuous scrolling experience while keeping dequeuing intact?
Expand Down Expand Up @@ -88,6 +93,12 @@ Christoffer Winterkvist, christoffer@winterkvist.com

We would love you to contribute to **Family**, check the [CONTRIBUTING](https://github.com/zenangst/Family/blob/master/CONTRIBUTING.md) file for more info.

## Credits

- [hyperoslo's Spots](https://github.com/hyperoslo/Spots) uses the same kind of implementation in order to render its component.
- [Ole Begemanns](https://github.com/ole/) implementation of [OLEContainerScrollView](https://github.com/ole/OLEContainerScrollView) is the basis for `SpotsScrollView`, we salute you.
Reference: http://oleb.net/blog/2014/05/scrollviews-inside-scrollviews/

## License

**Family** is available under the MIT license. See the [LICENSE](https://github.com/zenangst/Family/blob/master/LICENSE.md) file for more info.

0 comments on commit 5bfdd64

Please sign in to comment.