Skip to content

adsantos/GithubWrapper

Repository files navigation

GitHub API Wrapper in Objective-C

Installation

  1. Install CocoaPods.
  2. Clone this project
  3. In the home directory of this project, run pod install
  4. Open Wrapper.xcworkspace in XCode

Usage

In order to use this framework in another project, execute the following steps:

  1. Install CocoaPods.

  2. In the home directory of your project, create a file called Podfile and add the following:

    platform :ios
    
    pod 'GithubWrapper', :git => "git://github.com/adsantos/GithubWrapper.git"
    
  3. Run pod install

  4. Open the generated *.xcworkspace in XCode

  5. Run the Pods target

  6. Run your project target

Example

The GithubStats project uses this framework.

Testing

  1. Run the Pods target.
  2. Run the GithubStatsTests target.

TODO

  1. Add more Github API end-points.
  2. Add mocks with OCMock.
  3. Add OAuth support.
  4. Improve error messages.

Supported versions

iOS 5+

Contributing

  1. Fork the repository.
  2. Create a topic branch.
  3. Add specs for your unimplemented feature or bug fix.
  4. Run the tests. If your tests pass, return to step 3.
  5. Implement your feature or bug fix.
  6. Run the tests. If your tests fail, return to step 5.
  7. Add, commit, and push your changes.
  8. Submit a pull request.

Copyright

Copyright (c) 2012 Adriana Santos. See LICENSE for details.

About

An objective-c wrapper for the github api

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors