diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 38d86533..3b8d6f13 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,11 +1,11 @@ -# Contribute to CA Mobile App Services SDK +# Contribute to iOS Mobile SDK Contributions are welcome and much appreciated. Just follow these easy steps to contribute. ## Code Standard and Guideline -For consistency, we ask that you adhere to some basic code guidelines when contributing to the MAS SDK. See the [Code Standard and Guideline][guidelines] for details. +For consistency, we ask that you adhere to some basic code guidelines when contributing to the iOS Mobile SDK. See the [Code Standard and Guideline][guidelines] for details. ## Our Development Process -To continue improving the SDK, the MAS development team will work on the same GitHub repos as you. The `develop branch` is used for development, and the `master branch` is used only for stable releases. +To continue improving the SDK, our development team will work on the same GitHub repos as you. The `develop branch` is used for development, and the `master branch` is used only for stable releases. **Note:** For production environments, please use releases only from the master branch. ### Pull Requests @@ -14,7 +14,7 @@ We welcome and encourage pull requests. When we get a pull request, it is peer r Follow these steps for pull requests: 1. Fork the repo and create your branch from `master`. -4. For any new code, add unit tests. +2. For any new code, add unit tests. 3. If you've changed APIs, update code comments for AppleDocs. 4. Verify that the test suite passes. 5. Verify that your code follows the [Code Standard Guideline][guidelines] @@ -44,12 +44,12 @@ Before filing a new issue, check Known Issues to see if your problem already exi * Anything else that seems relevant. ## License -By contributing to CA Mobile App Services SDK, you agree that your contributions will be licensed under its [license][license-link]. +By contributing to iOS Mobile SDK, you agree that your contributions will be licensed under its [license][license-link]. - [guidelines]: /GUIDELINES.md - [community]: https://communities.ca.com/community/ca-api-management-community/content?filterID=contentstatus%5Bpublished%5D~category%5Bca-mobile-api-gateway%5D - [license-link]: /LICENSE - [cla]: https://www.clahub.com/agreements/CAAPIM/iOS-MAS-Foundation - [casupport]: https://support.ca.com/irj/portal/implsvcnewcase - +[guidelines]: /GUIDELINES.md +[community]: https://communities.ca.com/community/ca-api-management-community/content?filterID=contentstatus%5Bpublished%5D~category%5Bca-mobile-api-gateway%5D +[license-link]: /LICENSE +[cla]: https://www.clahub.com/agreements/CAAPIM/iOS-MAS-Foundation +[casupport]: https://support.ca.com/irj/portal/implsvcnewcase + diff --git a/GUIDELINES.md b/GUIDELINES.md index 125ee546..28972890 100644 --- a/GUIDELINES.md +++ b/GUIDELINES.md @@ -1,21 +1,19 @@ -# CA Technologies Mobile App Services Objective-C Style Guide +# CA Technologies Objective-C Style Guide -This document describes the Objective-C coding style of iOS team for CA Technologies Mobile App Services. This guideline is recommended to comply with all Objective-C implementations of our products. +This document describes the Objective-C coding style of the iOS Mobile SDK team. This guideline is recommended to comply with all Objective-C implementations of our products. -## Review Apple's Official Coding Guideline +## Review Apple Official Coding Guideline -Beyond the guidelines defined in this document, we also recommend reviewing Apple's official coding guidelines. +Beyond the guidelines defined in this document, we also recommend reviewing the Apple official coding guidelines. * [Programming with Objective-C](http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/ObjectiveC/Introduction/introObjectiveC.html) * [Cocoa Fundamentals Guide](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CocoaFundamentals/Introduction/Introduction.html) * [Coding Guidelines for Cocoa](https://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/CodingGuidelines/CodingGuidelines.html) * [App Programming Guide for iOS](http://developer.apple.com/library/ios/#documentation/iphone/conceptual/iphoneosprogrammingguide/Introduction/Introduction.html) -### MAS Products +### iOS Mobile SDK -For more information about MAS, see [Mobile App Service developer](http://mas.ca.com). - -Mobile App Services consists of multiple functional products separated into individual frameworks. +The iOS Mobile SDK consists these frameworks. * MASFoundation * MASUI @@ -23,7 +21,7 @@ Mobile App Services consists of multiple functional products separated into indi * MASIdentityManagement * MASStorage -All of frameworks are recommended to comply with the coding guideline. +All of frameworks are recommended to comply with the coding guideline. For more information about the iOS Mobile SDK, see [developer website](http://mas.ca.com). ## Table of Contents @@ -346,7 +344,7 @@ typedef NS_ENUM(NSInteger, MASRequestResponseType) + (MASObject *)currentObject; - (void)setObject:(id)object forKeyedSubscript:(id )key; -``` +``` **Not:** @@ -356,7 +354,7 @@ typedef NS_ENUM(NSInteger, MASRequestResponseType) +(MASObject*)currentObject; -(void)setObject:(id)object forKeyedSubscript:(id)key; -``` +``` #### Newline diff --git a/README.md b/README.md index 635b7ca0..abc786b3 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -MASFoundation is the core iOS framework of the Mobile SDK, which is part of [CA Mobile App Services][mas.ca.com]. MASFoundation handles the communication and authentication layer of the Mobile SDK, making it easy for developers to establish a secure connection (TLS, Mutual SSL) to any CA Mobile API Gateway (MAG). +MASFoundation is the core iOS framework of the iOS Mobile SDK, which is part of CA Mobile API Gateway. MASFoundation handles the communication and authentication layer of the iOS Mobile SDK, making it easy for developers to establish a secure connection (TLS, Mutual SSL) to any CA Mobile API Gateway (MAG). ## Features @@ -15,15 +15,15 @@ The MASFoundation framework has the following features: + OTP - One Time Password + PKCE - Proof Key for Code Exchange + SSL Pinning with certificate, public key, or public key hash + + Fingerprint Sessions Lock - Support phone unlocking using fingerprint recognition - Dynamic SDK Configuration - Enterprise Browser - Geo Location ## Get Started +- Check out our [documentation][docs] for sample code, video tutorials, and more. - [Download MASFoundation][download] -- Read the ["Getting Started" guide][get-started] or watch some [video tutorials][videos] -- Check out our [documentation][docs] for more details and sample codes ## Communication