43 Commits

Author SHA1 Message Date
Jesse Squires
895de471ba Regenerate docs, move docs build script
Summary:
- Move docs script to `scripts/`
- Add small note on README about regenerating docs
- Re-gen docs (doing this because of all the recent spelling, etc. fixes -- note, no breaking changes have landed, so we're good to re-gen.)
Closes https://github.com/Instagram/IGListKit/pull/797

Differential Revision: D5162705

Pulled By: rnystrom

fbshipit-source-id: 83cb0f171c10526a8a4b5d8a746fc2226987f256
2017-05-31 21:01:49 -07:00
Daniel Alamo
e278e6c27f Insert comma after "At Instagram" in readme.md
Summary:
Issue fixed: #762

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/780

Differential Revision: D5129315

Pulled By: rnystrom

fbshipit-source-id: d63e37c75ba633899ea8759c7c9c1baf023b1e2b
2017-05-26 08:17:15 -07:00
Daniel Alamo
0ab9e0323e Change help out to help in readme.md
Summary:
Issue fixed: #761

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/778

Differential Revision: D5129314

Pulled By: rnystrom

fbshipit-source-id: 3e0f3f9df908966d1e24f3827451a68ef72862f0
2017-05-25 07:33:53 -07:00
Hesham Salman
10007d6dc3 Add starter tasks to readme, close #754
Summary:
Issue fixed: #754

- [ ] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [ ] I added an entry to the `CHANGELOG.md` for any breaking changes, enhancements, or bug fixes.
- [ ] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/756

Differential Revision: D5103956

Pulled By: rnystrom

fbshipit-source-id: 212f7b3b7d7a8616d774f787fcb2e7cecf72d0db
2017-05-22 09:02:06 -07:00
Jesse Squires
9d102b9639 Fixup project, update README and guides
Summary:
- Fix OCMock issues with tvOS tests
- Update README/guides
Closes https://github.com/Instagram/IGListKit/pull/737

Differential Revision: D5052333

Pulled By: jessesquires

fbshipit-source-id: 958444d892c14dd4c75e244f20ae21bbfeec8290
2017-05-12 09:47:20 -07:00
James Sherlock
a8190f3db1 Update version number in docs
Summary:
Part of #707
Closes https://github.com/Instagram/IGListKit/pull/734

Differential Revision: D5046692

Pulled By: jessesquires

fbshipit-source-id: db43f99fd0bbf4186a1bd47070f28a9a446bc2a4
2017-05-11 13:07:11 -07:00
Jesse Squires
281e6416b2 Update README.md
Summary:
Adding some more "Getting started" resources
Closes https://github.com/Instagram/IGListKit/pull/640

Differential Revision: D4878807

Pulled By: jessesquires

fbshipit-source-id: d063242af31c91244278c997018d860c88f287ab
2017-04-12 15:04:29 -07:00
Jesse Squires
d930862c5f updates to README.md file
Summary:
A section added called Examples in the README file
Closes https://github.com/Instagram/IGListKit/pull/628

Differential Revision: D4860149

Pulled By: jessesquires

fbshipit-source-id: c3bad98a827f020b98bf81ada8d678ae8c697329
2017-04-10 09:34:21 -07:00
Jesse Squires
da4ef11f5b Add vision doc
Summary:
Adding a `VISION.md` doc at the root dir to give collaborators and users guidance about what we will work on and how we will prioritize features/fixes for IGListKit.

Issue fixed: #542

Closes https://github.com/Instagram/IGListKit/pull/607

Differential Revision: D4852285

Pulled By: jessesquires

fbshipit-source-id: 9588c1ade63d291d60a4ff34c50506c38b51b5b0
2017-04-07 15:23:47 -07:00
Sherlock
a748e6f6c7 Changed minimum macOS deployment target to 10.10
Summary:
Worth noting that while we support 10.8 and newer, Swift support is only 10.9 and newer. There were only a few more errors for 10.9 deployment target, but I'm not familiar with how it all works.

Using an `available` to disable row actions for users on 10.10 (only available for 10.11 and newer).
Closes https://github.com/Instagram/IGListKit/pull/374

Differential Revision: D4372977

Pulled By: jessesquires

fbshipit-source-id: 19f4b50c8eb4aa92f80241d69c44a367e854f5e8
2016-12-29 11:13:57 -08:00
James Sherlock
5cd771b546 Added Subspec for Diffing
Summary:
So the main Podspec file now has two Subspecs, `Diffing` and for lack of better name `Default`. `Diffing` is purely the files within the common directories (used for Diffing, if in the future we support MacOS NSCollectionView then this may need changing). `Default` depends on `Diffing` but also adds all the non-common files.

To use it via CocoaPods, nothing changes. You `import IGListKit` and you will only have access to the files in the pod you use. (So if you use `IGListKit/Diffing` in your Podfile, then you will only get access to the diffing files). If you do a manual installation, or I assume via Carthage, then you will need to import the correct header file (either `IGListDiffKit.h` or `IGListKit.h` depending on what you want).

Turns out CocoaPods creates it's own umbrella header (unless you tell it otherwise) meaning our ones are unused by it.

Just to confirm `IGListKit` in your Podfile will give you everything, only if you add `/Diffing` will you "opt-out" o
Closes https://github.com/Instagram/IGListKit/pull/368

Differential Revision: D4367438

Pulled By: jessesquires

fbshipit-source-id: 272318ca551e7e8c4177ca3ca501fde23bd9705a
2016-12-27 12:44:27 -08:00
Jesse Squires
b52510559d Fix podspec for macOS support
Summary: Closes https://github.com/Instagram/IGListKit/pull/330

Differential Revision: D4327087

Pulled By: jessesquires

fbshipit-source-id: a63ad7770763d95de1333be130673732706b7e36
2016-12-14 09:44:08 -08:00
Ryan Nystrom
f7e8bf1634 Fix sentence in readme
Summary:
Nits in the readme, not a full sentence.
Closes https://github.com/Instagram/IGListKit/pull/327

Differential Revision: D4325422

Pulled By: jessesquires

fbshipit-source-id: 6873aef68276107b793934b6b3e06d10fa10a8a4
2016-12-13 19:59:04 -08:00
Jesse Squires
478264cbc3 Update README.md
Summary: Closes https://github.com/Instagram/IGListKit/pull/321

Differential Revision: D4315759

Pulled By: rnystrom

fbshipit-source-id: 1be7e5799662874d4b41b738115cdb6cde32ed2a
2016-12-12 14:44:08 -08: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
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
Ryan Nystrom
b8d2c3bac0 Update docs with 2.0.0 links and copy, regen docs, pod install tests and examples
Summary: Title

Reviewed By: jessesquires

Differential Revision: D4306896

fbshipit-source-id: 134f3afd92d00bed1dee0b99b4f565a606027bdd
2016-12-09 11:44:36 -08:00
Jesse Squires
ead9d26a19 Fix links in README, close #256
Summary: Closes https://github.com/Instagram/IGListKit/pull/258

Differential Revision: D4232202

Pulled By: rnystrom

fbshipit-source-id: 947aebcca15fdef7db5def9eb6d0e0b7253624e9
2016-11-24 13:58:58 -08:00
Jesse Squires
8a6fde9e45 Initial setup for guides
Summary:
- Create `Guides/` top-level dir
- Move `README` "creating first list" contents into `Guides/Getting Started.md`
- Add initial `Guides/Migration.md` (ref #221)
- Fix #245

See rendered guides at:

- https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Getting%20Started.md
- https://github.com/Instagram/IGListKit/blob/guides-setup/Guides/Migration.md
Closes https://github.com/Instagram/IGListKit/pull/252

Differential Revision: D4228332

Pulled By: jessesquires

fbshipit-source-id: f26c2c1ee3cfefb40be1f99674702f95394d4aaf
2016-11-23 12:44:01 -08:00
Bofei Zhu
41859d2373 Fixes broken working range image
Summary: Closes https://github.com/Instagram/IGListKit/pull/248

Differential Revision: D4219184

Pulled By: jessesquires

fbshipit-source-id: 258f94cef32e0768c95c4a9e88b9e9af4fdec4f2
2016-11-21 22:28:57 -08:00
Jesse Squires
b0e6070861 Update README.md
Summary:
Per comments in #1.

Enough people asking about this to add it here.
Closes https://github.com/Instagram/IGListKit/pull/241

Differential Revision: D4215848

Pulled By: jessesquires

fbshipit-source-id: 455c1aa9aacabb8223e3e2506360648c9822237a
2016-11-21 14:14:02 -08:00
Jesse Squires
0980830d75 fix coveralls badge
Summary:
README badge had 91% even though coveralls says 95%.

Pasted badge code from coveralls.
Closes https://github.com/Instagram/IGListKit/pull/239

Differential Revision: D4213705

Pulled By: jessesquires

fbshipit-source-id: 5cf7cb85b5140555bfc8327770e6ddb1d9fb4e06
2016-11-21 09:58:58 -08:00
Anton Sotkov
c48a39aefe Update documentation for diff
Summary:
Update documentation for diff to be in sync with ab890fc607. Documentation update only, nothing to test.

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/.github/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/231

Differential Revision: D4211422

Pulled By: rnystrom

fbshipit-source-id: 9cb637e42300d9db173d99c1305845984d52ce7b
2016-11-20 08:29:04 -08:00
Sherlock
1e7fa064ab Update links to new path
Summary:
- Fixed broken links in README.md and CHANGELOG.md
- Also updated to use relative links

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/212

Differential Revision: D4192912

Pulled By: rnystrom

fbshipit-source-id: 991e0637ce36772801f3c4ab6146980f2930973d
2016-11-16 15:13:57 -08:00
Jesse Squires
e4a47193c1 Add tvOS support. Close #118
Summary:
Closes #118.

- Add tvOS framework + test targets
- Add shared scheme `IGListKit-tvOS`
- Update `Podfile` and `.podspec`
- Update `.travis.yml`
- Update `CHANGELOG`
- Update `README`
- Run `pod install` and check-in updates

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/137

Differential Revision: D4101583

Pulled By: rnystrom

fbshipit-source-id: f2736f16ad9f61ad5348c5e93571f3b752deec98
2016-10-29 14:44:11 -07:00
Jesse Squires
e207ae52bf Move contributing.md to .github. Close #114
Summary:
Move contributing.md to .github. Close #114
Closes https://github.com/Instagram/IGListKit/pull/136

Differential Revision: D4101580

Pulled By: rnystrom

fbshipit-source-id: b54cc9b0fe97b58bfd3914e7cc36859cadcbc0b7
2016-10-29 14:44:11 -07:00
Ryan Nystrom
b99776e5b5 Center and trim badges, add love to readme
Summary:
- Trimmed badges that I think are a little unnecessary
- Added a heart to the "made by"

cc jessesquires thoughts?

- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/117

Differential Revision: D4089119

Pulled By: rnystrom

fbshipit-source-id: ee9602fc5b7cb9bb004a624ffde89a5dc3c3e743
2016-10-27 10:14:04 -07:00
Jake Lin
d1003df845 Update the Swift code syntax for reflecting the current APIs for Swift.
Summary:
In this PR, we updated the Swift code syntax for reflecting the current APIs for Swift.

- [x] All tests pass. Demo project builds and runs.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/116

Differential Revision: D4089084

Pulled By: rnystrom

fbshipit-source-id: 9c90c2f6d5c52d202086a05efc3fe3b07da41ce3
2016-10-27 09:59:07 -07:00
Jesse Squires
efca62d37d Update README.md
Summary:
A few minor tweaks to clarify things
Closes https://github.com/Instagram/IGListKit/pull/120

Differential Revision: D4074874

Pulled By: rnystrom

fbshipit-source-id: 6f3318044dc3efeb5676d913fe916b26f567ae7c
2016-10-25 09:59:22 -07:00
Ryan Nystrom
d78c0b4e13 Add Coveralls support and badge
Summary:
Adding Coverall support and badge in README. Waiting on tests. Fixes #37

- [x] All tests pass. Demo project builds and runs.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/110

Differential Revision: D4066685

Pulled By: rnystrom

fbshipit-source-id: a9f148fe87e9d25c60afca88c02410898db9b10a
2016-10-23 17:29:11 -07:00
Jake Lin
0ecd0ddd9e Update example code to make it more Swifty
Summary:
In this PR, we updated example code to make it more Swifty by removing `CGRect` for using `.zero` only.

- [x] All tests pass. Demo project builds and runs.
- [ ] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/111

Differential Revision: D4065463

Pulled By: rnystrom

fbshipit-source-id: 089258466e320c58afc9d547f78a481ce9458e49
2016-10-22 20:14:15 -07:00
Jesse Squires
459bfd1bc3 fix readme build badge
Summary: Closes https://github.com/Instagram/IGListKit/pull/95

Differential Revision: D4051336

Pulled By: jessesquires

fbshipit-source-id: a9e98aadcad7f02b886169e67a8b6ddfff542474
2016-10-20 09:29:28 -07:00
Ryan Nystrom
f7d80e29f3 Update working range docs
Summary:
Docs were out of sync. Working range used to be an attempt to use a range outside the visible bounds, but that's not the case anymore. Instead it is just a number of section controllers beyond the visible range (much simpler). Updated the docs and graphic to reflect this.

Fixes #84

Reviewed By: dshahidehpour

Differential Revision: D4043045

fbshipit-source-id: bc4ae7a5a822626ffda30ff5ac7a3782a3816027
2016-10-19 19:14:24 -07:00
Chris Amanse
ab21a7f669 Fix typo in connecting data source code in README
Summary:
Only README.md was changed. Fixed the typo in example code for connecting data source (replace opening parenthesis with whitespace).

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/64

Reviewed By: jessesquires

Differential Revision: D4012595

Pulled By: rnystrom

fbshipit-source-id: f27774e20c7a2ec3154cacbf919fd295625bace4
2016-10-14 11:14:15 -07:00
ReadmeCritic
8b32b80aac Correct the spelling of CocoaPods in README
Summary:
This pull request corrects the spelling of **CocoaPods** 🤓
https://github.com/CocoaPods/shared_resources/tree/master/media

<blockquote class="twitter-tweet" data-lang="en"><p lang="en" dir="ltr">One day I’ll make a bot that looks through the READMEs of all Pods, looks to see if it uses “Cocoapods” and PRs “CocoaPods” :D</p>&mdash; Ørta (orta) <a href="https://twitter.com/orta/status/697374357975388160">February 10, 2016</a></blockquote>
<script async src="//platform.twitter.com/widgets.js" charset="utf-8"></script>

Created with [`cocoapods-readme`](https://github.com/dkhamsing/cocoapods-readme).
Closes https://github.com/Instagram/IGListKit/pull/59

Reviewed By: ocrickard

Differential Revision: D4009138

Pulled By: jessesquires

fbshipit-source-id: fedaa51e883a78e52de4f7d934e0945b946cc751
2016-10-12 11:14:17 -07:00
James Kuang
a7124a0fe5 Update README 'pk' to 'primaryKey' for consistency
Summary:
Updated README example for naming consistency

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/58

Reviewed By: ryanolsonk, ocrickard

Differential Revision: D4008590

Pulled By: rnystrom

fbshipit-source-id: 74412ca77054cd6a15c0783b95f5d7a87eaf4c96
2016-10-12 07:59:14 -07:00
Ryan Nystrom
6e3656449f Update User copy in readme to a real-world example
Summary:
Copy changes. Can proof them here: https://github.com/Instagram/IGListKit/tree/readme

I got some feedback that the `User` example didn't make sense (*why would you have two users with the same pk?*).

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/50

Reviewed By: jessesquires

Differential Revision: D4006618

Pulled By: rnystrom

fbshipit-source-id: 9673788b643785d223b67ab1b23315edfc5874cb
2016-10-11 19:44:04 -07:00
Martin Arista
7a48b429cd Add carthage instal steps
Summary:
Added Carthage Install Steps #13

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/48

Differential Revision: D4005535

Pulled By: jessesquires

fbshipit-source-id: 5414c1e967abfbbe7a5d199b1e3b09b844e52c63
2016-10-11 17:44:09 -07:00
Marcelo Fabri
78b37f49a5 CocoaPods spelling in README
Summary:
Just a nitpick.
Closes https://github.com/Instagram/IGListKit/pull/44

Reviewed By: jessesquires

Differential Revision: D4002826

Pulled By: rnystrom

fbshipit-source-id: c2472435505d2e16ffd8285811793b6c2bb904d9
2016-10-11 13:14:09 -07:00
Adam Sharp
f833986df2 Use type checking instead of casting in README
Summary:
Just a little improvement to a code example.

- [x] All tests pass. Demo project builds and runs.
- [x] I added tests, an experiment, or detailed why my change isn't tested.
- [x] I have reviewed the [contributing guide](https://github.com/Instagram/IGListKit/blob/master/CONTRIBUTING.md)
Closes https://github.com/Instagram/IGListKit/pull/45

Reviewed By: jessesquires

Differential Revision: D4002830

Pulled By: rnystrom

fbshipit-source-id: b6fb8f87752f0886333c4445107caac8219027e9
2016-10-11 12:14:10 -07:00
Ryan Nystrom
e15311a0a2 Add carthage badge to readmme
Summary: Title

Reviewed By: jessesquires

Differential Revision: D4002935

fbshipit-source-id: d407942c49407807776e1d911177c040c25f4355
2016-10-11 11:59:07 -07:00
Ryan Nystrom
1bcd5f0019 Fix logo with absolute URL
Summary: Title

Reviewed By: jessesquires

Differential Revision: D4002448

fbshipit-source-id: 5f117da26d4dcfe7d6b45b3378f0471575f363b8
2016-10-11 11:44:20 -07:00
FBShipIt
cdc796746a Initial commit
fbshipit-source-id: c38b897b9e2b87c782e0e01b0145d9189dc7f9d8
2016-10-11 10:12:17 -04:00