From ae94cf4be47a642819d0f478c100ea1616d2d80b Mon Sep 17 00:00:00 2001 From: Nick Date: Thu, 17 Apr 2025 10:50:30 +0200 Subject: [PATCH] update README.md --- README.md | 64 +++++++++---------------------------------------------- 1 file changed, 10 insertions(+), 54 deletions(-) diff --git a/README.md b/README.md index a52b571..e8f1e21 100644 --- a/README.md +++ b/README.md @@ -41,14 +41,11 @@ If you are not using Cocoapods in your project, follow the instruction of the se ### Cocoapods -#### Get the SDK thru Xcode Cloud +#### Get the SDK via public repo 1. Add the following lines inside your target declaration in your `Podfile`. - Remember to: - - - add the source to our specs repo - - replace `X.Y.Z` with the pod version provided (ex. 3.18.14) + Remember to add the source to our specs repo ``` ... @@ -59,63 +56,22 @@ target '' do ... -pod 'NewsmemorySDK', 'X.Y.Z' +pod 'NewsmemorySDK', '3.18.14' ... end ``` - - -#### Get the SDK thru GitHub - -1. Create a new SSH key and name it `id_tecnavia_deploy_key`, put the key files in folder `~/.ssh/`(see this article for reference https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent). Then, in order to be able to download the software from Tecnavia repository, you should provide to Tecnavia your public key. - -2. Edit your SSH config file `~/.ssh/config` and add the following lines: - -``` -#GitHub Tecnavia Repo -Host tecnavia-repo-sdk - HostName github.com - AddKeysToAgent yes - PreferredAuthentications publickey - IdentityFile ~/.ssh/id_tecnavia_deploy_key -``` - -3. Add the following lines inside your target declaration in your `Podfile`. - - Remember to: - - - add the source to our specs repo - - replace `X.Y.Z` with the pod version provided (ex. 3.18.14) - -``` -... -source 'https://github.com/tecnaviapress/Specs.git' -... - -target '' do - -... - -pod 'NewsmemorySDK', 'X.Y.Z' - -... - -end -``` - -4. Run `pod install`. If you upgrade from a previous version of NewsmemorySDK run `pod install --repo-update` +2. If you are building locally, run `pod install`. If you upgrade from a previous version of NewsmemorySDK run `pod install --repo-update` #### Get the SDK thru zip file -Tecnavia provides you a zip package named `ta-newsmemory-sdk_XYZ`, where XYZ stands for the package version (ex. 31814, means that the SDK version is 3.18.14). +Tecnavia provides you a zip package named `ta-newsmemory-sdk_31814`, (i.e. 31814, means that the SDK version is 3.18.14). -1. Unzip the package and copy the `ta-newsmemory-sdk_XYZ` folder in the folder containing your project's `Podfile` file. +1. Unzip the package and copy the `ta-newsmemory-sdk_31814` folder in the folder containing your project's `Podfile` file. 2. Add the following lines inside your target declaration in your `Podfile`. - Notice that `XYZ` stands for the package version (ex. 31814) ``` ... @@ -124,7 +80,7 @@ target '' do ... -pod 'NewsmemorySDK', path: 'ta-newsmemory-sdk_XYZ' +pod 'NewsmemorySDK', path: 'ta-newsmemory-sdk_31814' ... @@ -141,11 +97,11 @@ end #### Package contents -Tecnavia provides you a zip package named `ta-newsmemory-sdk_XYZ`, where XYZ stands for the package version (ex. 31814, means that the SDK version is 3.18.14). +Tecnavia provides you a zip package named `ta-newsmemory-sdk_31814`, (i.e. 31814, means that the SDK version is 3.18.14). -Unzip the package and copy the `ta-newsmemory-sdk_XYZ` folder in the folder containing your project's `.xcodeproj` file (i.e. the SDK folder must be at the same level of the project file). +Unzip the package and copy the `ta-newsmemory-sdk_31814` folder in the folder containing your project's `.xcodeproj` file (i.e. the SDK folder must be at the same level of the project file). -The unzipped folder named `ta-newsmemory-sdk_XYZ` has the following subfolders structure: +The unzipped folder named `ta-newsmemory-sdk_31814` has the following subfolders structure: ``` .