From 4985fbbc5abcfef175cdcc765975314581ea9c94 Mon Sep 17 00:00:00 2001 From: Nadya Karaban Date: Wed, 27 Mar 2024 15:50:07 +0100 Subject: [PATCH] docs(GiniHealthSDK): Remove manual installation section, outdated migration guide, update licence. IPC-218 --- .../Documentation/source/Installation.md | 27 +++---------------- .../Documentation/source/License.md | 4 +-- .../Documentation/source/Migration guide.md | 21 --------------- 3 files changed, 5 insertions(+), 47 deletions(-) delete mode 100644 HealthSDK/GiniHealthSDK/Documentation/source/Migration guide.md diff --git a/HealthSDK/GiniHealthSDK/Documentation/source/Installation.md b/HealthSDK/GiniHealthSDK/Documentation/source/Installation.md index 5a205be75..2bd9a9ff8 100644 --- a/HealthSDK/GiniHealthSDK/Documentation/source/Installation.md +++ b/HealthSDK/GiniHealthSDK/Documentation/source/Installation.md @@ -10,34 +10,13 @@ Once you have your Swift package set up, adding `GiniHealthSDK` as a dependency ```swift dependencies: [ - .package(url: "https://github.com/gini/health-sdk-ios.git", .exact("3.0.1")) + .package(url: "https://github.com/gini/health-sdk-ios.git", .exact("4.0.0")) ] ``` -In case that you want to use the certificate pinning in the library, add `GiniHealthAPILibraryPinning`: +In case that you want to use [the certificate pinning](https://www.ssl.com/blogs/what-is-certificate-pinning/#:~:text=Certificate%20pinning%20is%20a%20security,(Transport%20Layer%20Security)%20protocols.) in the library, add `GiniHealthAPILibraryPinning`: ```swift dependencies: [ - .package(url: "https://github.com/gini/health-sdk-pinning-ios.git", .exact("3.0.1")) + .package(url: "https://github.com/gini/health-sdk-pinning-ios.git", .exact("4.0.0")) ] ``` - -## Manually - -If you prefer not to use a dependency management tool, you can integrate the Gini Health SDK into your project manually. -To do so drop the [GiniHealthSDK](https://github.com/gini/gini-mobile-ios/tree/main/HealthSDK/GiniHealthSDK) (classes and assets) folder into your project as well as its dependant libraries like [GiniHealthAPILibrary](https://github.com/gini/gini-mobile-ios/tree/main/HealthAPILibrary/GiniHealthAPILibrary) and add the files to your target. - -For manual installation [GiniHealthSDKPinning](https://github.com/gini/gini-mobile-ios/tree/main/HealthSDK/GiniHealthSDKPinning) you need to copy the sources and assets of its dependencies: - - [GiniHealthAPILibrary](https://github.com/gini/gini-mobile-ios/tree/main/HealthAPILibrary/GiniHealthAPILibrary) - - [GiniHealthAPILibraryPinning](https://github.com/gini/gini-mobile-ios/tree/main/HealthAPILibrary/GiniHealthAPILibraryPinning) - - [GiniHealthSDK](https://github.com/gini/gini-mobile-ios/tree/main/HealthSDK/GiniHealthSDK) - -You can find the list of dependencies [here](https://github.com/gini/gini-mobile-ios/blob/main/HealthSDK/GiniHealthSDKPinning/Package.swift). - -Xcode will automatically check your project for swift files and will create an autogenerated import header for you. -Use this header in an Objective-C project by adding - -```Obj-C -#import "YourProjectName-Swift.h" -``` - -to your implementation or header files. Note that spaces in your project name result in underscores. So `Your Project` becomes `Your_Project-Swift.h`. diff --git a/HealthSDK/GiniHealthSDK/Documentation/source/License.md b/HealthSDK/GiniHealthSDK/Documentation/source/License.md index 1b42eb828..03a96f55b 100644 --- a/HealthSDK/GiniHealthSDK/Documentation/source/License.md +++ b/HealthSDK/GiniHealthSDK/Documentation/source/License.md @@ -4,7 +4,7 @@ Always make sure to ship all license notices and permissions with your applicati ## The Gini Health SDK for iOS is licensed under a Private License. - Copyright (c) 2014-2022, Gini GmbH + Copyright (c) 2024, Gini GmbH All rights reserved. The Gini Health SDK is licensed through Gini GmbH ("Gini") and may not be @@ -19,7 +19,7 @@ Always make sure to ship all license notices and permissions with your applicati ## The Gini Health SDK Pinning for iOS is licensed under a Private License. - Copyright (c) 2014-2022, Gini GmbH + Copyright (c) 2024, Gini GmbH All rights reserved. The Gini Health SDK Pinning is licensed through Gini GmbH ("Gini") and may not be diff --git a/HealthSDK/GiniHealthSDK/Documentation/source/Migration guide.md b/HealthSDK/GiniHealthSDK/Documentation/source/Migration guide.md deleted file mode 100644 index 8ded7092e..000000000 --- a/HealthSDK/GiniHealthSDK/Documentation/source/Migration guide.md +++ /dev/null @@ -1,21 +0,0 @@ -Migrate from the Gini Pay Business SDK -======================================= - -We've migrated from CocoaPods to Swift Package Manager. Please, find more details in [Installation](https://developer.gini.net/gini-mobile-ios/GiniHealthSDK/installation.html). - -Update classes - -Replace `GiniApiLib` with `GiniHealthAPI`. -Replace `GiniPayBusiness` with `GiniHealth`. -Replace `GiniPayBusinessConfiguration` with `GiniHealthConfiguration`. -Replace `GiniPayBusinessDelegate` with `GiniHealthDelegate`. -Replace `GiniPayBusinessError` with `GiniHealthError`. - -Localizable strings - -Replace `ginipaybusiness.*` with `ginihealth.*`. - -Migrate from Pay API Library to Health API Library -=================================================== - -See the Health API Library's [migration guide](https://developer.gini.net/gini-mobile-ios/GiniHealthAPILibrary/migration-guide.html). \ No newline at end of file