Skip to content

Commit 5bee586

Browse files
committed
Update README.md and pod spec
1 parent ccf31c8 commit 5bee586

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

PokemonKit.podspec

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Pod::Spec.new do |s|
1010
s.name = "PokemonKit"
11-
s.version = "0.1.0"
11+
s.version = "1.0.0"
1212
s.summary = "A wrapper for pokeapi v2"
1313

1414
# This description is used to generate tags and improve search results.
@@ -17,15 +17,16 @@ Pod::Spec.new do |s|
1717
# * Write the description between the DESC delimiters below.
1818
# * Finally, don't worry about the indent, CocoaPods strips it!
1919
s.description = <<-DESC
20-
A wrapper for pokeapi v2, written in swift
20+
PokemonKit is a swift wrapper for Pokeapi.
21+
PokemonKit use Alamofire and PromiseKit for async web requests handling.
2122
DESC
2223

2324
s.homepage = "https://github.com/darkcl/PokemonKit"
2425
# s.screenshots = "www.example.com/screenshots_1", "www.example.com/screenshots_2"
2526
s.license = 'MIT'
2627
s.author = { "Yeung Yiu Hung" => "[email protected]" }
2728
s.source = { :git => "https://github.com/darkcl/PokemonKit.git", :tag => s.version.to_s }
28-
# s.social_media_url = 'https://twitter.com/<TWITTER_USERNAME>'
29+
s.social_media_url = 'https://twitter.com/darkcl_dev'
2930

3031
s.platform = :ios, '8.0'
3132
s.requires_arc = true

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,37 @@
55
[![License](https://img.shields.io/cocoapods/l/PokemonKit.svg?style=flat)](http://cocoapods.org/pods/PokemonKit)
66
[![Platform](https://img.shields.io/cocoapods/p/PokemonKit.svg?style=flat)](http://cocoapods.org/pods/PokemonKit)
77

8+
## What is this?
9+
PokemonKit is a swift wrapper for Pokeapi.
10+
11+
PokemonKit use Alamofire and PromiseKit for async web requests handling.
12+
813
## Usage
914

10-
To run the example project, clone the repo, and run `pod install` from the Example directory first.
15+
```swift
16+
import PokemonKit
17+
18+
PokemonKit.fetchBerry("1")
19+
.then { berryInfo in
20+
self.testLabel.text = berryInfo.name;
21+
}.error {error in
22+
print(error)
23+
}
24+
```
25+
26+
## TODO
1127

12-
## Requirements
28+
- [x] Wrap all API end points
29+
- [ ] Fully Documented
30+
- [ ] Fully tested
1331

1432
## Installation
1533

1634
PokemonKit is available through [CocoaPods](http://cocoapods.org). To install
1735
it, simply add the following line to your Podfile:
1836

1937
```ruby
20-
pod "PokemonKit"
38+
pod 'PokemonKit'
2139
```
2240

2341
## Author

0 commit comments

Comments
 (0)