Skip to content

Commit

Permalink
Merge pull request #17 from checkout/no-jira-update-docs
Browse files Browse the repository at this point in the history
no-jira - Update docs
  • Loading branch information
precious-ossai-cko authored Dec 15, 2023
2 parents 88fb329 + a410a80 commit 03aa816
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
3 changes: 1 addition & 2 deletions .github/partial-readmes/Installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,10 +35,9 @@ platform :ios, '12.0'
use_frameworks!

target '<Your Target Name>' do
pod 'Risk', '~> 1.0'
pod 'Risk', '~> 0.0.2'
end
```
<!-- TODO: Update pod version (https://checkout.atlassian.net/browse/PRISM-10088) -->

Then, run the following command in terminal:

Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Risk iOS package
<!-- TODO: Uncomment when repo is public (https://checkout.atlassian.net/browse/PRISM-10088) -->
<!-- [![CocoaPods Compatible](https://img.shields.io/cocoapods/v/Risk.svg)](https://img.shields.io/cocoapods/v/Risk)
[![CocoaPods Compatible](https://img.shields.io/cocoapods/v/Risk.svg)](https://img.shields.io/cocoapods/v/Risk)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/checkout/checkout-risk-sdk-ios?label=spm)
[![Platform](https://img.shields.io/cocoapods/p/Risk.svg?style=flat)]()
![license](https://img.shields.io/github/license/checkout/checkout-risk-sdk-ios.svg) -->
![license](https://img.shields.io/github/license/checkout/checkout-risk-sdk-ios.svg)

The package helps collect device data for merchants with direct integration (standalone) with the package and those using [Checkout's Frames iOS package](https://github.com/checkout/frames-ios).

## Table of contents
Expand All @@ -27,7 +27,7 @@ The package helps collect device data for merchants with direct integration (sta

## Documentation
### Usage guide
1. Add `Risk` as a package dependency - _see [Installation guide](https://github.com/checkout/checkout-risk-sdk-ios/blob/main/.github/partial-readmes/Integration.md) on how to add our SDK in your iOS app via SPM or Cocoapods._
1. Add `Risk` as a package dependency - _see [Installation guide](https://github.com/checkout/checkout-risk-sdk-ios/blob/main/.github/partial-readmes/Installation.md) on how to add our SDK in your iOS app via SPM or Cocoapods._
2. Obtain a public API key from [Checkout Dashboard](https://dashboard.checkout.com/developers/keys).
3. Initialise the package with the `getInstance` method passing in the required configuration (public API key and environment), then publish the device data with the `publishData` method, see example below.
```swift
Expand Down

0 comments on commit 03aa816

Please sign in to comment.