Files
IGListKit/README.md
Jesse Squires faa4595b56 Update README.md
Summary:
Just a few tweaks, less verbose.

Also -- removed the "manual" installation. I don't think hardly anyone uses this. Plus, I don't think a simple drag + drop would work because of `OCMock`.
Closes https://github.com/Instagram/IGListKit/pull/313

Differential Revision: D4313111

Pulled By: rnystrom

fbshipit-source-id: 4796d94e9f4c853220780074807e902a7390c037
2016-12-12 07:14:10 -08:00

3.3 KiB

Build Status Coverage Status Pods Version Carthage Compatible


A data-driven UICollectionView framework for building fast and flexible lists.

Main Features
🙅 Never call performBatchUpdates(_:, completion:) or reloadData() again
🏠 Better architecture with reusable cells and components
🔠 Create collections with multiple data types
🔑 Decoupled diffing algorithm
Fully unit tested
🔍 Customize your diffing behavior for your models
📱 Simply UICollectionView at its core
🚀 Extendable API
🐦 Written in Objective-C with full Swift interop support

IGListKit is built and maintained with ❤️ by Instagram engineering. We use the open source version master branch in the Instagram app.

Requirements

  • Xcode 8.0+
  • iOS 8.0+
  • tvOS 9.0+
  • Interoperability with Swift 3.0+

Installation

CocoaPods

The preferred installation method for IGListKit is with CocoaPods. Add the following to your Podfile:

# Latest release of IGListKit
pod 'IGListKit', '~> 2.0.0'

# Use the master branch (we use this at Instagram)
pod 'IGListKit', :git => 'https://github.com/Instagram/IGListKit.git', :branch => 'master'

Carthage

If using Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 2.0.0

Getting Started

See the Getting Started guide here.

Documentation

You can find the docs here. Documentation is generated with jazzy and hosted on GitHub-Pages.

Contributing

Please see the CONTRIBUTING file for how to help out. At Instagram we sync the open source version of IGListKit daily, so we're always testing the latest changes. But that requires all changes be thoroughly tested follow our style guide.

License

IGListKit is BSD-licensed. We also provide an additional patent grant.

The files in the /Examples/ directory are licensed under a separate license as specified in each file. Documentation is licensed CC-BY-4.0.