Skip to content

Commit 7599116

Browse files
authored
fix: update readme with warning and proper naming (#155)
1 parent 836a319 commit 7599116

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

README.md

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The **AWS SDK for Swift** is a pure Swift SDK for AWS services.
44

5-
**WARNING: All interfaces are subject to change.**
5+
**WARNING: Releases prior to 1.0.0 may contain bugs and no guarantee is made about API stability. They are not intended for use in production!**
66

77
## License
88

@@ -55,7 +55,7 @@ Testing generated services requires `ClientRuntime` of `smithy-swift` and `AWSCl
5555

5656
1. We have all of the AWS SDKs available in our alpha release listed under `/release` except AWS Locations (coming soon).
5757

58-
We will walk you through how you can use Cognitoidentity as dependency for example in the steps below. To use it, we will create a test project called TestSdk.
58+
We will walk you through how you can use `CognitoIdentity` as dependency for example in the steps below. To use it, we will create a test project called TestSdk.
5959

6060
```bash
6161
mkdir TestSdk
@@ -67,8 +67,8 @@ xed .
6767
Once Xcode is open, open Package.swift. Update the file to mirror the following. Notice the three following changes:
6868

6969
* Platforms is set to `[.macOS(.v10_15), .iOS(.v13)]`,
70-
* dependencies: - has a .package which references the Cognitoidentity package
71-
* the first target “TestSDK” has a dependency listed as “Cognitoidentity”
70+
* dependencies: - has a .package which references the `CognitoIdentity` package
71+
* the first target “TestSDK” has a dependency listed as `CognitoIdentity`
7272

7373
```swift
7474
// swift-tools-version:5.4
@@ -87,7 +87,7 @@ let package = Package(
8787
// Targets can depend on other targets in this package, and on products in packages this package depends on.
8888
.target(
8989
name: "TestSdk",
90-
dependencies: [.product(name: "Cognitoidentity", package: "AWSSwiftSDK")]),
90+
dependencies: [.product(name: "CognitoIdentity", package: "AWSSwiftSDK")]),
9191
.testTarget(
9292
name: "TestSdkTests",
9393
dependencies: ["TestSdk"]),
@@ -104,33 +104,33 @@ AWS_SECRET_ACCESS_KEY
104104
```
105105
(if you need help with getting these values, talk to wooj@ or nickik@
106106

107-
Then you can open up main.swift, and instantiate Cognitoidentity as follows:
107+
Then you can open up main.swift, and instantiate CognitoIdentity as follows:
108108

109109
```swift
110-
import Cognitoidentity
110+
import CognitoIdentity
111111
import Foundation
112112

113113
//this config file will be moved out of the client,
114114
// I realize this is a pain right now and we have an open ticket for it.
115-
let config = try! CognitoidentityClient.CognitoidentityClientConfiguration.default()
116-
let cognitoIdentityClient = CognitoidentityClient(config: config)
115+
let config = try! CognitoIdentityClient.CognitoIdentityClientConfiguration.default()
116+
let cognitoIdentityClient = CognitoIdentityClient(config: config)
117117
let cognitoInputCall = CreateIdentityPoolInput(allowClassicFlow: nil,
118-
allowUnauthenticatedIdentities: true,
119-
cognitoIdentityProviders: nil,
120-
developerProviderName: "com.amazonaws.mytestapplication",
121-
identityPoolName: "identityPoolMadeWithSwiftSDK",
122-
identityPoolTags: nil,
123-
openIdConnectProviderARNs: nil,
124-
samlProviderARNs: nil,
125-
supportedLoginProviders: nil)
118+
allowUnauthenticatedIdentities: true,
119+
cognitoIdentityProviders: nil,
120+
developerProviderName: "com.amazonaws.mytestapplication",
121+
identityPoolName: "identityPoolMadeWithSwiftSDK",
122+
identityPoolTags: nil,
123+
openIdConnectProviderARNs: nil,
124+
samlProviderARNs: nil,
125+
supportedLoginProviders: nil)
126126

127127
cognitoIdentityClient.createIdentityPool(input: cognitoInputCall) { (result) in
128-
switch(result) {
129-
case .success(let output):
130-
print("\(output)")
131-
case .failure(let error):
132-
print("\(error)")
133-
}
128+
switch(result) {
129+
case .success(let output):
130+
print("\(output)")
131+
case .failure(let error):
132+
print("\(error)")
133+
}
134134
}
135135
```
136136

0 commit comments

Comments
 (0)