Skip to content

Commit 9cf16db

Browse files
authored
Merge pull request #622 from miguelarauj1o/patch-1
Fix space between headers and text
2 parents b6404e6 + 2cf1530 commit 9cf16db

File tree

1 file changed

+35
-35
lines changed

1 file changed

+35
-35
lines changed

README.md

Lines changed: 35 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
#AWS Mobile SDK for iOS
1+
# AWS Mobile SDK for iOS
22

33
[![Release](https://img.shields.io/github/release/aws/aws-sdk-ios.svg)]()
44
[![CocoaPods](https://img.shields.io/cocoapods/v/AWSiOSSDKv2.svg)]()
55
[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)
66
[![Twitter Follow](https://img.shields.io/twitter/follow/AWSforMobile.svg?style=social&label=Follow)](https://twitter.com/AWSforMobile)
77

8-
##Setting Up
8+
## Setting Up
99

1010
To get started with the AWS SDK for iOS, you can set up the SDK and start building a new project, or you integrate the SDK in an existing project. You can also run the samples to get a sense of how the SDK works.
1111

@@ -18,7 +18,7 @@ At the AWS GitHub repo, you can check out the [SDK source code](https://github.c
1818

1919
For more information, see [AWS Mobile SDK for iOS Developer Guide](http://docs.aws.amazon.com/mobile/sdkforios/developerguide/).
2020

21-
##Include the SDK for iOS in an Existing Application
21+
## Include the SDK for iOS in an Existing Application
2222

2323
The [samples](https://github.com/awslabs/aws-sdk-ios-samples) included with the SDK for iOS are standalone projects that are already set up for you. You can also integrate the SDK for iOS with your own existing project. There are three ways to import the AWS Mobile SDK for iOS into your project:
2424

@@ -28,7 +28,7 @@ The [samples](https://github.com/awslabs/aws-sdk-ios-samples) included with the
2828

2929
You should use one of these three ways to import the AWS Mobile SDK but not multiple. Importing the SDK in multiple ways loads duplicate copies of the SDK into the project and causes compiler errors.
3030

31-
###CocoaPods
31+
### CocoaPods
3232

3333
1. The AWS Mobile SDK for iOS is available through [CocoaPods](http://cocoapods.org). If you have not installed CocoaPods, install CocoaPods by running the command:
3434

@@ -82,7 +82,7 @@ You should use one of these three ways to import the AWS Mobile SDK but not mult
8282
ld: library not found for -lPods-AWSCore
8383
clang: error: linker command failed with exit code 1 (use -v to see invocation)
8484

85-
###Carthage
85+
### Carthage
8686

8787
1. Install the latest version of [Carthage](https://github.com/Carthage/Carthage#installing-carthage).
8888

@@ -129,7 +129,7 @@ You should use one of these three ways to import the AWS Mobile SDK but not mult
129129
Input Files: Empty
130130
Output Files: Empty
131131

132-
###Frameworks
132+
### Frameworks
133133

134134
1. Download the SDK from our [AWS Mobile SDK](http://aws.amazon.com/mobile/sdk) page. The SDK is stored in a compressed file archive named `aws-ios-sdk-#.#.#` (where `#.#.#` represents the version number, so for version 2.5.0, the filename is `aws-ios-sdk-2.5.0`).
135135

@@ -168,11 +168,11 @@ You should use one of these three ways to import the AWS Mobile SDK but not mult
168168
Input Files: Empty
169169
Output Files: Empty
170170

171-
##Update the SDK to a Newer Version
171+
## Update the SDK to a Newer Version
172172

173173
When we release a new version of the SDK, you can pick up the changes as described below.
174174

175-
###CocoaPods
175+
### CocoaPods
176176

177177
1. Run the following command in your project directory. CocoaPods automatically picks up the new changes.
178178

@@ -182,13 +182,13 @@ When we release a new version of the SDK, you can pick up the changes as describ
182182

183183
![image](readme-images/cocoapods-setup-03.png?raw=true)
184184

185-
###Carthage
185+
### Carthage
186186

187187
1. Run the following command in your project directory. Carthage automatically picks up the new changes.
188188

189189
$ carthage update
190190

191-
###Frameworks
191+
### Frameworks
192192

193193
1. In Xcode select the following frameworks in **Project Navigator** and hit **delete** on your keyboard. Then select **Move to Trash**:
194194

@@ -213,7 +213,7 @@ When we release a new version of the SDK, you can pick up the changes as describ
213213

214214
1. Follow the installation process above to include the new version of the SDK.
215215

216-
##Preparing your apps for iOS 9
216+
## Preparing your apps for iOS 9
217217
The release of iOS 9 includes changes that might impact how your apps interact with some AWS services. If you compile your apps with Apple’s iOS 9 SDK (or Xcode 7), Apple’s [App Transport Security (ATS)](https://developer.apple.com/library/prerelease/ios/documentation/General/Reference/InfoPlistKeyReference/Articles/CocoaKeys.html) feature may affect the ability of apps to connect to certain AWS service endpoints. In order to ensure affected apps continue to successfully connect to AWS endpoints, you’ll need to configure them to interact properly with Apple’s ATS by adding these properties to your `Info.plist` file:
218218

219219
<key>NSAppTransportSecurity</key>
@@ -243,7 +243,7 @@ The release of iOS 9 includes changes that might impact how your apps interact w
243243

244244
For more information, see [Preparing Your Apps for iOS 9](http://docs.aws.amazon.com/mobile/sdkforios/developerguide/ats.html).
245245

246-
##Getting Started with Swift
246+
## Getting Started with Swift
247247

248248
1. Import the AWSCore header in the application delegate.
249249

@@ -288,7 +288,7 @@ For more information, see [Preparing Your Apps for iOS 9](http://docs.aws.amazon
288288
289289
**Note**: Most of the service client classes have a singleton method to get a default client. The naming convention is `+ defaultSERVICENAME` (e.g. `+ defaultDynamoDB` in the above code snippet). This singleton method creates a service client with `defaultServiceConfiguration`, which you set up in step 5, and maintains a strong reference to the client.
290290

291-
##Getting Started with Objective-C
291+
## Getting Started with Objective-C
292292

293293
1. Import the AWSCore header in the application delegate.
294294

@@ -326,11 +326,11 @@ For more information, see [Preparing Your Apps for iOS 9](http://docs.aws.amazon
326326

327327
**Note**: Most of the service client classes have a singleton method to get a default client. The naming convention is `+ defaultSERVICENAME` (e.g. `+ defaultS3TransferManager` in the above code snippet). This singleton method creates a service client with `defaultServiceConfiguration`, which you set up in step 5, and maintains a strong reference to the client.
328328

329-
##AWSTask
329+
## AWSTask
330330

331331
With native AWSTask support in the SDK for iOS, you can chain async requests instead of nesting them. It makes the logic cleaner, while keeping the code more readable. Read [Working with AWSTask](http://docs.aws.amazon.com/mobile/sdkforios/developerguide/awstask.html) to learn how to use AWSTask.
332332

333-
##Logging
333+
## Logging
334334

335335
Changing log levels during development may make debugging easier. You can change the log level by importing AWSCore.h and calling:
336336

@@ -362,80 +362,80 @@ The following logging level options are available:
362362

363363
We recommend setting the log level to `None` before publishing to the Apple App Store.
364364

365-
##Sample Apps
365+
## Sample Apps
366366

367367
The AWS SDK for iOS includes sample apps that demonstrate common use cases.
368368

369-
###Cognito Your User Pools Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoYourUserPools-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoYourUserPools-Sample/Objective-C/))
369+
### Cognito Your User Pools Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoYourUserPools-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoYourUserPools-Sample/Objective-C/))
370370

371371
This sample demonstrates how sign up and sign in a user to display an authenticated portion of your app.
372372

373-
###Cognito Sync Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoSync-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoSync-Sample/Objective-C/))
373+
### Cognito Sync Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoSync-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/CognitoSync-Sample/Objective-C/))
374374

375375
This sample demonstrates how to securely manage and sync your mobile app data and create unique identities via login providers including Facebook, Google, and Login with Amazon.
376376

377-
####AWS Services Demonstrated:
377+
#### AWS Services Demonstrated:
378378

379379
* [Amazon Cognito Sync](http://aws.amazon.com/cognito/)
380380
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
381381

382-
###DynamoDB Object Mapper Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/DynamoDBObjectMapper-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/DynamoDBObjectMapper-Sample/Objective-C/))
382+
### DynamoDB Object Mapper Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/DynamoDBObjectMapper-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/DynamoDBObjectMapper-Sample/Objective-C/))
383383

384384
This sample demonstrates how to insert / update / delete / query items using DynamoDB Object Mapper.
385385

386-
####AWS Services Demonstrated:
386+
#### AWS Services Demonstrated:
387387

388388
* [Amazon DynamoDB](http://aws.amazon.com/dynamodb/)
389389
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
390390

391-
###S3 Transfer Manager Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3TransferManager-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3TransferManager-Sample/Objective-C/))
391+
### S3 Transfer Manager Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3TransferManager-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3TransferManager-Sample/Objective-C/))
392392

393393
This sample demonstrates how to upload / download multiple files simultaneously using S3 Transfer Manager. It also shows how to pause, resume, and cancel file upload / download.
394394

395-
####AWS Services Demonstrated:
395+
#### AWS Services Demonstrated:
396396

397397
* [Amazon S3](http://aws.amazon.com/s3/)
398398
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
399399

400-
###S3 Transfer Utility Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3BackgroundTransfer-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3BackgroundTransfer-Sample/Objective-C/))
400+
###S 3 Transfer Utility Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3BackgroundTransfer-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/S3BackgroundTransfer-Sample/Objective-C/))
401401

402402
This sample demonstrates how to use the Amazon S3 PreSigned URL Builder to download / upload files in background.
403403

404-
####AWS Services Demonstrated:
404+
#### AWS Services Demonstrated:
405405

406406
* [Amazon S3](http://aws.amazon.com/s3/)
407407
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
408408

409409

410-
###SNS Mobile Push and Mobile Analytics Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/SNS-MobileAnalytics-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/SNS-MobileAnalytics-Sample/Objective-C/))
410+
### SNS Mobile Push and Mobile Analytics Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/SNS-MobileAnalytics-Sample/Swift/), [Objective-C](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/SNS-MobileAnalytics-Sample/Objective-C/))
411411

412412
This sample demonstrates how to set up Amazon SNS Mobile Push and record events using Amazon Mobile Analytics.
413413

414-
####AWS Services Demonstrated:
414+
#### AWS Services Demonstrated:
415415

416416
* [Amazon SNS Mobile Push](http://aws.amazon.com/sns/)
417417
* [Amazon Mobile Analytics](http://aws.amazon.com/mobileanalytics/)
418418
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
419419

420-
###IoT Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/IoT-Sample/Swift/))
420+
### IoT Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/IoT-Sample/Swift/))
421421

422422
This sample demonstrates how to publish and subscribe to data using AWS IoT.
423423

424-
####AWS Services Demonstrated:
424+
#### AWS Services Demonstrated:
425425

426426
* [Amazon AWS IoT](http://aws.amazon.com/iot/)
427427
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
428428

429-
###IoT Temperature Control Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/IoTTemperatureControl-Sample/Swift/))
429+
### IoT Temperature Control Sample ([Swift](https://github.com/awslabs/aws-sdk-ios-samples/tree/master/IoTTemperatureControl-Sample/Swift/))
430430

431431
This sample demonstrates accessing device shadows using Cognito authentication; it works in conjunction with the Temperature Control Example Program in the [AWS IoT JavaScript SDK for Embedded Devices](https://github.com/aws/aws-iot-device-sdk-js).
432432

433-
####AWS Services Demonstrated:
433+
#### AWS Services Demonstrated:
434434

435435
* [Amazon AWS IoT](http://aws.amazon.com/iot/)
436436
* [Amazon Cognito Identity](http://aws.amazon.com/cognito/)
437437

438-
##Install the Reference Documentation in Xcode
438+
## Install the Reference Documentation in Xcode
439439

440440
The AWS Mobile SDK for iOS zip file includes documentation in the DocSets format that you can view within Xcode. The easiest way to install the documentation is to use the Mac OS X terminal.
441441

@@ -455,14 +455,14 @@ The AWS Mobile SDK for iOS zip file includes documentation in the DocSets format
455455

456456
1. If Xcode was running during this procedure, restart Xcode. To browse the documentation, go to **Help**, click **Documentation and API Reference**, and select **AWS Mobile SDK for iOS v2.5.0 Documentation** (where '2.5.0' is the appropriate version number).
457457

458-
##Talk to Us
458+
## Talk to Us
459459

460460
Visit our GitHub [Issues](https://github.com/aws/aws-sdk-ios/issues) to leave feedback and to connect with other users of the SDK.
461461

462-
##Author
462+
## Author
463463

464464
Amazon Web Services
465465

466-
##License
466+
## License
467467

468468
See the **LICENSE** file for more info.

0 commit comments

Comments
 (0)