Skip to content

Commit

Permalink
docs(GiniHealthSDK): Remove manual installation section, outdated mig…
Browse files Browse the repository at this point in the history
…ration guide, update licence.

IPC-218
  • Loading branch information
zladzeyka committed Mar 27, 2024
1 parent 52a57d8 commit 4985fbb
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 47 deletions.
27 changes: 3 additions & 24 deletions HealthSDK/GiniHealthSDK/Documentation/source/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
4 changes: 2 additions & 2 deletions HealthSDK/GiniHealthSDK/Documentation/source/License.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
21 changes: 0 additions & 21 deletions HealthSDK/GiniHealthSDK/Documentation/source/Migration guide.md

This file was deleted.

0 comments on commit 4985fbb

Please sign in to comment.