Skip to content

Commit fd45e4d

Browse files
authored
Update wording on README.md (#235) (#253)
* update readme * removed note * updating link to SDK docs * updated sdk link * Add explicit instructions for using workspace
1 parent 389cb6e commit fd45e4d

File tree

1 file changed

+15
-10
lines changed

1 file changed

+15
-10
lines changed

README.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,13 @@ Our default implementation works with Amazon Web Services (AWS), but AWS Amplify
88
https://aws-amplify.github.io/docs/ios/start
99

1010
## Features/APIs
11-
*Note: Amplify docs are still being updated and will go live by EOW. The below links will take you to the SDK documentation currently.
1211

1312
- [**Analytics**](https://aws-amplify.github.io/docs/ios/analytics): Easily collect analytics data for your app. Analytics data includes user sessions and other custom events that you want to track in your app.
14-
- [**API**](https://aws-amplify.github.io/docs/ios/api): Provides a simple solution when making HTTP requests. It provides an automatic, lightweight signing process which complies with AWS Signature Version 4.
15-
- [**GraphQL Client**](https://aws.github.io/aws-amplify/media/api_guide#configuration-for-graphql-server): Interact with your GraphQL server or AWS AppSync API with an easy-to-use & configured GraphQL client.
16-
- [**Storage**](https://aws-amplify.github.io/docs/ios/storage): Provides a simple mechanism for managing user content for your app in public, protected or private storage buckets.
13+
- [**API**](https://aws-amplify.github.io/docs/ios/api): Interact with your AWS AppSync API or make HTTP requests to your API Gateway endpoint with Amplify API. It provides a GraphQL client interface to use with Amplify Tool's model generation and automatic signing process to authenticate your requests.
14+
- [**Storage**](https://aws-amplify.github.io/docs/ios/storage): Provides a simple mechanism for managing user content for your app in guest, protected or private storage buckets.
1715
- [**Predictions**](https://aws-amplify.github.io/docs/ios/predictions): Provides a solution for using AI and ML cloud services to enhance your application.
1816

19-
All services and features not listed above are supported via the [iOS SDK](https://github.com/aws-amplify/aws-sdk-ios) or if supported by a category can be accessed via the Escape Hatch like below:
17+
All services and features not listed above are supported via the [iOS SDK](https://aws-amplify.github.io/docs/sdk/ios/start) or if supported by a category can be accessed via the Escape Hatch like below:`
2018

2119
``` swift
2220
let rekognitionService = Amplify.Predictions.getEscapeHatch(key: .rekognition) as! AWSRekognition
@@ -49,9 +47,16 @@ Coming soon, will be live by December 6. You can use manually in the mean time p
4947
You can manually install the library by cloning this repo and creating a Podfile that references your local clone of it like below:
5048

5149
``` ruby
52-
pod 'Amplify', :path => '~/Projects/Amplify/amplify-ios'
53-
pod 'AWSPluginsCore', :path => '~/Projects/Amplify/amplify-ios'
54-
pod 'CoreMLPredictionsPlugin', :path => '~/Projects/Amplify/amplify-ios'
55-
pod 'AmplifyPlugins/AWSPredictionsPlugin', :path => '~/Projects/Amplify/amplify-ios'
50+
pod 'Amplify', :path => '~/amplify-ios'
51+
pod 'AWSPluginsCore', :path => '~/amplify-ios'
52+
pod 'CoreMLPredictionsPlugin', :path => '~/amplify-ios'
53+
pod 'AWSPredictionsPlugin', :path => '~/amplify-ios'
54+
pod 'AmplifyPlugins/AWSAPIPlugin', :path => '~/amplify-ios'
5655
```
57-
You also need to go to your target project by clicking the top level project in Xcode and then clicking under Targets on your project. Then head to Build Phases -> Link Binary with Libraries -> Add Amplify Frameworks and any others you need for the category or categories you would like to use.
56+
57+
Then, install the dependencies:
58+
```
59+
pod install
60+
```
61+
62+
Open your project using ./YOUR-PROJECT-NAME.xcworkspace file. Remember to always use ./YOUR-PROJECT-NAME.xcworkspace to open your Xcode project from now on.

0 commit comments

Comments
 (0)