IGListKit/README.md at fc56c02ceca63da9cb4b1215d15c20aef8a8907e

mirror of https://github.com/Instagram/IGListKit synced 2026-05-24 09:48:21 +00:00

Jesse Squires fc56c02cec Update README.md

Summary:
rnystrom - I know you removed this before, but I think we should add it back now that we support > 1 platform. 😄

(and macOS is coming up in #235 )
Closes https://github.com/Instagram/IGListKit/pull/322

Differential Revision: D4314033

Pulled By: rnystrom

fbshipit-source-id: d768d0ce19df0154609ab639f0acb8d95fe2b7da

2016-12-12 11:14:19 -08:00

3.4 KiB

Raw Blame History

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.

3.4 KiB Raw Blame History