Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
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 #313

Differential Revision: D4313111

Pulled By: rnystrom

fbshipit-source-id: 4796d94e9f4c853220780074807e902a7390c037
  • Loading branch information
jessesquires authored and Facebook Github Bot committed Dec 12, 2016
1 parent 2ca1577 commit faa4595
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ A data-driven `UICollectionView` framework for building fast and flexible lists.
🚀 | Extendable API
🐦 | Written in Objective-C with full Swift interop support

`IGListKit` is built and maintained with ❤️ by [Instagram engineering](https://engineering.instagram.com/), using the open source version for the Instagram app.
`IGListKit` is built and maintained with ❤️ by [Instagram engineering](https://engineering.instagram.com/).
We use the open source version `master` branch in the Instagram app.

## Requirements

Expand All @@ -50,28 +51,25 @@ A data-driven `UICollectionView` framework for building fast and flexible lists.

### CocoaPods

The preferred installation method for `IGListKit` is with [CocoaPods](https://cocoapods.org). Simply add the following to your `Podfile`:
The preferred installation method for `IGListKit` is with [CocoaPods](https://cocoapods.org).
Add the following to your `Podfile`:

```ruby
# Latest release of IGListKit
pod '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

To integrate `IGListKit` into your Xcode project using [Carthage](https://github.com/Carthage/Carthage), specify it in your `Cartfile`:
If using [Carthage](https://github.com/Carthage/Carthage), add the following to your `Cartfile`:

```ogdl
github "Instagram/IGListKit" ~> 2.0.0
```

### Manually

You can also manually install the framework by dragging and dropping the `IGListKit.xcodeproj` into your project or workspace.

## Getting Started

See the [Getting Started guide here](https://instagram.github.io/IGListKit/getting-started.html).
Expand All @@ -82,10 +80,10 @@ You can find [the docs here](https://instagram.github.io/IGListKit). Documentati

## Contributing

Please see the [CONTRIBUTING](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) file for how to help out. At Instagram we sync the open source version of `IGListKit` almost daily, so we're always testing the latest changes. But that requires all changes be thoroughly tested follow our style guide.
Please see the [CONTRIBUTING](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md) 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 /Example directory are licensed under a separate license as specified in each file; documentation is licensed [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).
The files in the `/Examples/` directory are licensed under a separate license as specified in each file. Documentation is licensed [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/).

0 comments on commit faa4595

Please sign in to comment.