mirror of https://github.com/Instagram/IGListKit synced 2026-05-19 15:28:54 +00:00

Zhisheng Huang f3175ec31f Update the version to be 4.0

Summary:
As title, let's prepare the 4.0 release with the version bump.

1. Change the Source/Info.plist to have 4.0.0 for CFBundleShortVersionString.
2. Manually update any .md files that used the old release versions.
3. Run `./scripts/setup.sh` to re-update all the pods and the Example projects.

Reviewed By: natestedman

Differential Revision: D18616823

fbshipit-source-id: ca0f2a09cdd9ab592c2cb002fe923e195ce3ab12

2019-11-20 16:23:15 -08:00

1.7 KiB

Raw Blame History

Installation

This guide provides details on how to install IGListKit.

CocoaPods

The preferred method of installation for IGListKit is using CocoaPods.

In order to use the latest release of the framework, add the following to your Podfile:

pod 'IGListKit', '~> 4.0'

Using `master`

Alternatively, you can use the latest version from the master branch. This is what we use at Instagram, so you can be confident that master is always stable and reliable.

pod 'IGListKit', :git => 'https://github.com/Instagram/IGListKit.git', :branch => 'master'

Note: while master is stable, it may have breaking changes. Before updating to master, be sure to check the CHANGELOG for details on changes.

Subspecs

With the exception of macOS (which currently only supports the diffing algorithm components), using pod 'IGListKit' will get you the full library, including the flexible UICollectionView system. Learn more about how to get started in our Getting Started guide.

However, if you only want to use the diffing components of this library, then you can use the diffing subspec in your Podfile:

pod 'IGListKit/Diffing', '~> 4.0'

Regardless of whether you only use the diffing components, or the entire library, the imports are the same:

import IGListKit

Carthage

If using Carthage, add the following to your Cartfile:

github "Instagram/IGListKit" ~> 4.0

1.7 KiB Raw Blame History