Skip to content

Commit

Permalink
Readme Updates: v2.1.3
Browse files Browse the repository at this point in the history
- Updated readme for v2.1.3 with instructions and structure improvements.
  • Loading branch information
ashokds committed Jun 4, 2019
1 parent 4f038e8 commit 71dc730
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,38 @@

The DocuSign Native iOS SDK is a framework for Objective-C and Swift projects. Using the SDK, you can integrate the online and offline signing features of DocuSign into your own iOS application.

For detailed instructions, please refer to the [official site](https://developers.docusign.com/ios_sdk/).
For detailed instructions and getting started with DocuSign Sandbox, please refer to the [official site](https://developers.docusign.com/ios_sdk/).

Requirements
============
- The SDK is written in Objective-C, but will work with projects in Objective-C or Swift (4.x and later).
- The framework uses Apple's Core Data for data persistence.
- Requires iOS 9.0 or later.
- It is recommended developers use Xcode 9.x or later.
- It is recommended developers use Xcode 10.x or later.

Install
=============

**CocoaPods**

* Refer to [Getting Started Guide](https://guides.cocoapods.org/using/getting-started.html) if new to CocoaPods
* Add `pod 'DocuSign'` to podfile
* Run `pod install` to get the DocuSign Native iOS SDK `v2.1.3`
Refer to [Getting Started Guide](https://guides.cocoapods.org/using/getting-started.html) to install CocoaPods via `gem install cocoapods` command and initialize the project. Take a look at sample projects included here [swift app](docusign-sdk-sample-swift/) and [objective-c app](docusign-sdk-sample-objc/).

* Add `pod 'DocuSign'` to podfile to target(s) in your project. Example: [Swift Sample App Podfile](docusign-sdk-sample-swift/Podfile)
* Run `pod install` in the same directory as your `Podfile` to get the DocuSign Native iOS SDK pod. This should result in `Installing DocuSign (2.1.3)` output on the console and corresponding changes in the `Podfile.lock`.
* Launch modified `.xcworkspace` project file with Xcode and use workspace going forward instead of `.xcodeproj` file.

**Manual Integration Guide**
* Download the `DocuSignSDK.zip` and unarchive it. Copy the `DocuSignSDK.framework` to root folder of sample apps `docusign-sdk-sample-objc` and `docusign-sdk-sample-swift`.
* Refer the [Getting Started](https://developers.docusign.com/ios_sdk/developer.html) and [Integration](https://developers.docusign.com/ios_sdk/developer.html) section on the **Developer's Site** for more details.

Reference Docs
==============
[Reference Docs](https://developers.docusign.com/ios_sdk/refdocs/html/annotated.html) section on the **Developer's Site** has more details.
**Manual Integration Guide**
* Download the [DocuSignSDK.zip](DocuSignSDK.zip) and unarchive it.
* Copy the `DocuSignSDK.framework` to root folder of your app and follow the steps on the [Integration](https://developers.docusign.com/ios_sdk/developer.html) section.

[Git Large File Storage](https://git-lfs.github.com/) to checkin the framework binary file with Git

Sample Apps
Support
===========
[Sample Apps](https://developers.docusign.com/ios_sdk/developer.html) section on the **Developer's Site** has more details.

* Refer the [Getting Started](https://developers.docusign.com/ios_sdk/developer.html) and [Integration](https://developers.docusign.com/ios_sdk/developer.html) section on the **Developer's Site** for more details on creating DocuSign Sandbox Account, Integration and using SDK Core Interfaces.
* [Reference Docs](https://developers.docusign.com/ios_sdk/refdocs/html/annotated.html) to browse the latest developer documentation including API reference and public header files
* Raise an issue here on GitHub for quick response.
* We also have an active developer community on Stack Overflow, search the [DocuSignAPI](http://stackoverflow.com/questions/tagged/docusignapi) tag.

License
=======
Expand Down

0 comments on commit 71dc730

Please sign in to comment.