Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Brian Donohue <brian@team.instapaper.com>
  • Loading branch information
Brian Donohue committed Nov 30, 2018
1 parent f0e70b8 commit 7d49de8
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,17 @@
[![License](https://img.shields.io/cocoapods/l/IPShortcut.svg?style=flat)](https://cocoapods.org/pods/IPShortcut)
[![Platform](https://img.shields.io/cocoapods/p/IPShortcut.svg?style=flat)](https://cocoapods.org/pods/IPShortcut)

## Example
![IPShortcut screenshot](/screenshot.png)

To run the example project, clone the repo, and run `pod install` from the Example directory first.
## About

IPShortcut lets you easily add UIKeyCommand shortcuts for view controllers displaying information in UITableView, UICollectionView, and UIScrollView. Integration is really straightforward, just make your view controller a subclass of IPShortcutTableViewController, IPShortcutCollectionViewController, or IPShortcutScrollViewController.

After subclassing, your view controller will automatically have arrow key shortcuts to navigate cells (or scroll a scrollview), space and shiftspace to page up or down, and enter to open a cell using the appropriate delegate function.

## Requirements
## Example Project

To run the example project, clone the repo, and run `pod install` from the Example directory first.

## Installation

Expand Down
Binary file added screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 7d49de8

Please sign in to comment.