OctoKit is a Cocoa and Cocoa Touch framework for interacting with the GitHub API, built using AFNetworking, Mantle, and ReactiveCocoa.

OctoKit is still new and moving fast, so we may make breaking changes from time-to-time, but it has partial unit test coverage and is already being used in GitHub for Mac's production code.

To add OctoKit to your application:

1. Add the OctoKit repository as a submodule of your application's repository.
2. Run script/bootstrap from within the OctoKit folder.
3. Drag and drop OctoKit.xcodeproj into your application's Xcode project or workspace.
4. On the "Build Phases" tab of your application target, add OctoKit to the "Link Binary With Libraries" phase.
   • On iOS, add libOctoKit.a.
   • On OS X, add OctoKit.framework. The framework must also be added to any "Copy Frameworks" build phase. If you don't already have one, simply add a "Copy Files" build phase and target the "Frameworks" destination.
5. Add $(BUILD_ROOT)/../IntermediateBuildFilesPath/UninstalledProducts/include $(inherited) to the "Header Search Paths" build setting (this is only necessary for archive builds, but it has no negative effect otherwise).
6. For iOS targets, add -ObjC to the "Other Linker Flags" build setting.

OctoKit is released under the MIT license. See LICENSE.md.