Pokeapi wrapper, written in Swift
Swift Shell Other
Latest commit ac8eae6 Aug 29, 2016 @darkcl darkcl committed on GitHub Update README.md

README.md

PokemonKit

Build Status Version License Platform Carthage compatible codebeat badge ghit.me

What is this?

PokemonKit is a swift wrapper for Pokeapi.

PokemonKit use Alamofire and PromiseKit for async web requests handling.

Usage

import PokemonKit

PokemonKit.fetchBerry("1")
            .then { berryInfo in
                self.testLabel.text = berryInfo.name;
            }.onError {error in
                print(error)
        }

TODO

  • Wrap all API end points
  • Fully Documented
  • Fully tested
  • Carthage Support
  • Unit test don't call server
  • Remove PromiseKit (So many build errors, not worth it)

Installation

PokemonKit is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod 'PokemonKit'

If your using Carthage you can add a PokemonKit by adding it to your Cartfile:

github "ContinuousLearning/PokemonKit" ~> 2.0

In your Info.plist, add

<key>NSAppTransportSecurity</key>
<dict>
    <key>NSExceptionDomains</key>
    <dict>
        <key>pokeapi.co</key>
        <dict>
            <key>NSIncludesSubdomains</key>
            <true/>
            <key>NSTemporaryExceptionAllowsInsecureHTTPLoads</key>
            <true/>
            <key>NSTemporaryExceptionMinimumTLSVersion</key>
            <string>TLSv1.1</string>
        </dict>
    </dict>
</dict>

Author

Yeung Yiu Hung, hkclex@gmail.com

License

PokemonKit is available under the MIT license. See the LICENSE file for more info.