Skip to content

Commit 3ba4df0

Browse files
committed
Updated README
1 parent 30afd57 commit 3ba4df0

File tree

1 file changed

+34
-2
lines changed

1 file changed

+34
-2
lines changed

README.md

+34-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,34 @@
1+
##This fork contains a working version of the SDK for Cocoa. Please read below on usage.##
2+
3+
To use in Cocoa applications, do a recursive clone:
4+
5+
git clone --recursive https://github.com/jawngee/aws-sdk-ios-v2.git
6+
7+
This fork has added the dependencies as submodules for a couple of reasons. First, and I'm probably alone in this feeling, but I hate cocoapods for a number of valid and invalid reasons.
8+
9+
Second, the iOS specific code actually exists in the Bolts dependency, but can still be compiled and used with the iOS specific classes removed.
10+
11+
Once you've cloned the repo, to get it working in your project:
12+
13+
1. Drag the AWSiOSSDK.xcodeproj to your project.
14+
2. In build phases, add "AWSCocoaSDK" as a *Target Dependency*.
15+
3. In *Link Binary With Libraries* phase, add "libAWSCocoaSDK.a"
16+
4. In build settings, in *Header Search Paths*, add the directory where you cloned this repo to and make sure that it is recursive.
17+
5. Add -ObjC to *Other Linker Flags*.
18+
19+
You can now include in your code:
20+
21+
#import "AWSCore/AWSCore.h"
22+
#import "SQS/AWSSQS.h"
23+
24+
You should now be good to go. I will be tracking Amazon's repo and merging in changes as they are made.
25+
26+
BTW, there's no good reason this can't work both in iOS and Cocoa, except the iOS engineers at Amazon have decided to include a dependency that requires it (though the actual iOS Specific stuff isn't used at all).
27+
28+
Anyways, enjoy.
29+
30+
31+
132
**This is a developer preview of the AWS SDK for iOS v2. The repository name may change when the SDK goes out of the preview.**
233

334
# Version 2 of the AWS SDK for iOS Developer Preview
@@ -35,7 +66,7 @@ it simply add the following line to your **Podfile**:
3566

3667
pod "AWSiOSSDKv2"
3768

38-
## Getting Started is Easy Using Swift
69+
## Getting Started is Easy Using Swift
3970

4071
It is easy to use the AWS SDK for iOS with Swift. Please see five simple steps below to get started with Swift.
4172

@@ -97,7 +128,8 @@ It is easy to use the AWS SDK for iOS with Swift. Please see five simple steps b
97128
return nil;
98129
}];
99130

100-
## Talk to UsThis is a Developer Preview, and we will make changes based on your feedback. Visit the [Issues]() to leave feedback and to connect with other users of the SDK.
131+
## Talk to Us
132+
This is a Developer Preview, and we will make changes based on your feedback. Visit the [Issues]() to leave feedback and to connect with other users of the SDK.
101133

102134
## Author
103135

0 commit comments

Comments
 (0)