Skip to content

Commit 2ade432

Browse files
committed
CocoaPods support.
1 parent 0be3f6f commit 2ade432

File tree

2 files changed

+51
-8
lines changed

2 files changed

+51
-8
lines changed

PostgresClientKit.podspec

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Pod::Spec.new do |spec|
2+
spec.name = "PostgresClientKit"
3+
spec.version = "0.2.0"
4+
spec.summary = "A PostgreSQL client library for Swift. Does not require libpq."
5+
spec.homepage = "https://github.com/codewinsdotcom/PostgresClientKit"
6+
spec.license = "Apache License, Version 2.0"
7+
spec.author = "David Pitfield"
8+
9+
spec.description = <<-DESC
10+
PostgresClientKit provides a friendly Swift API for operating against a PostgreSQL database.
11+
12+
Features:
13+
14+
- Doesn't require libpq
15+
- Developer-friendly API using modern Swift
16+
- Safe conversion between Postgres and Swift types
17+
- Memory efficient
18+
- SSL/TLS support
19+
DESC
20+
21+
spec.swift_version = "5.0"
22+
spec.ios.deployment_target = "10.0"
23+
spec.osx.deployment_target = "10.12"
24+
spec.source = { :git => "https://github.com/codewinsdotcom/PostgresClientKit.git", :tag => "v#{spec.version}" }
25+
spec.source_files = "Sources/**/*.swift"
26+
27+
spec.dependency "BlueSocket", "~> 1.0"
28+
spec.dependency "BlueSSLService", "~> 1.0"
29+
end

README.md

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ swift build
8989

9090
## Testing
9191

92-
[Set up a Postgres database for testing](Docs/setting_up_a_postgres_database_for_testing.md). This is a one-time process.
92+
[Set up a Postgres database for testing](https://github.com/codewinsdotcom/PostgresClientKit/blob/master/Docs/setting_up_a_postgres_database_for_testing.md). This is a one-time process.
9393

9494
Then:
9595

@@ -132,13 +132,27 @@ import PostgresClientKit
132132

133133
### CocoaPods
134134

135-
CocoaPods support is [on the roadmap](https://github.com/codewinsdotcom/PostgresClientKit/issues/2).
135+
Add `PostgresClientKit` to your `Podfile`. For example:
136+
137+
```
138+
target 'MyApp' do
139+
pod 'PostgresClientKit', '~> 0.1'
140+
end
141+
```
142+
143+
Then run `pod install`.
144+
145+
Import to your source code file:
146+
147+
```swift
148+
import PostgresClientKit
149+
```
136150

137151
## Documentation
138152

139153
- [API documentation](https://codewinsdotcom.github.io/PostgresClientKit/Docs/API/index.html)
140-
- [Troubleshooting](Docs/troubleshooting.md)
141-
- [FAQ](Docs/faq.md)
154+
- [Troubleshooting](https://github.com/codewinsdotcom/PostgresClientKit/blob/master/Docs/troubleshooting.md)
155+
- [FAQ](https://github.com/codewinsdotcom/PostgresClientKit/blob/master/Docs/faq.md)
142156

143157
## Additional examples
144158

@@ -150,9 +164,9 @@ CocoaPods support is [on the roadmap](https://github.com/codewinsdotcom/Postgres
150164

151165
Thank you for your interest in contributing to PostgresClientKit.
152166

153-
This project has a code of conduct. See [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) for details.
167+
This project has a code of conduct. See [CODE_OF_CONDUCT.md](https://github.com/codewinsdotcom/PostgresClientKit/blob/master/CODE_OF_CONDUCT.md) for details.
154168

155-
Please use [issues](../../issues) to:
169+
Please use [issues](https://github.com/codewinsdotcom/PostgresClientKit/issues) to:
156170

157171
- ask questions
158172
- report problems (bugs)
@@ -162,11 +176,11 @@ Pull requests against the `develop` branch are welcomed. For a non-trivial cont
162176

163177
## License
164178

165-
PostgresClientKit is licensed under the Apache 2.0 license. See [LICENSE](LICENSE) for details.
179+
PostgresClientKit is licensed under the Apache 2.0 license. See [LICENSE](https://github.com/codewinsdotcom/PostgresClientKit/blob/master/LICENSE) for details.
166180

167181
## Versioning
168182

169-
PostgresClientKit uses [Semantic Versioning 2.0.0](https://semver.org). For the versions available, see the [tags on this repository](../../tags).
183+
PostgresClientKit uses [Semantic Versioning 2.0.0](https://semver.org). For the versions available, see the [tags on this repository](https://github.com/codewinsdotcom/PostgresClientKit/releases).
170184

171185
## Built with
172186

0 commit comments

Comments
 (0)