diff --git a/Demo-Carthage/CartFile b/Demo-Carthage/CartFile index 5edf0a1..51838ca 100644 --- a/Demo-Carthage/CartFile +++ b/Demo-Carthage/CartFile @@ -1 +1 @@ -github "charlymr/IRLPDFScanContent" ~> 1.0.2 +github "charlymr/IRLPDFScanContent" ~> 1.1.0 diff --git a/Demo-Cocoapods/Podfile b/Demo-Cocoapods/Podfile index 1cc0926..a575662 100644 --- a/Demo-Cocoapods/Podfile +++ b/Demo-Cocoapods/Podfile @@ -1,6 +1,6 @@ platform :ios, '13.0' target "IRLPDFScanDemo" do - pod 'IRLPDFScanContent', '~> 1.0.2' + pod 'IRLPDFScanContent', '~> 1.1.0' use_frameworks! end \ No newline at end of file diff --git a/Demo-Cocoapods/Podfile.lock b/Demo-Cocoapods/Podfile.lock deleted file mode 100644 index a524178..0000000 --- a/Demo-Cocoapods/Podfile.lock +++ /dev/null @@ -1,16 +0,0 @@ -PODS: - - IRLPDFScanContent (1.0.2) - -DEPENDENCIES: - - IRLPDFScanContent (~> 1.0.2) - -SPEC REPOS: - trunk: - - IRLPDFScanContent - -SPEC CHECKSUMS: - IRLPDFScanContent: 4bba070f8d0cb34b1c500804d3879c47f908c283 - -PODFILE CHECKSUM: 63a853f6eb9292d4047ed0b03fad3ebf06bbd160 - -COCOAPODS: 1.11.2 diff --git a/IRLPDFScanContent.xcodeproj/project.pbxproj b/IRLPDFScanContent.xcodeproj/project.pbxproj index 99d0c4b..be4b6f6 100644 --- a/IRLPDFScanContent.xcodeproj/project.pbxproj +++ b/IRLPDFScanContent.xcodeproj/project.pbxproj @@ -345,7 +345,7 @@ "@executable_path/Frameworks", "@loader_path/Frameworks", ); - MARKETING_VERSION = 1.0.2; + MARKETING_VERSION = 1.1.0; PRODUCT_BUNDLE_IDENTIFIER = com.irlmobile.IRLPDFScanContent; PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; SKIP_INSTALL = YES; @@ -375,7 +375,7 @@ "@executable_path/Frameworks", "@loader_path/Frameworks", ); - MARKETING_VERSION = 1.0.2; + MARKETING_VERSION = 1.1.0; PRODUCT_BUNDLE_IDENTIFIER = com.irlmobile.IRLPDFScanContent; PRODUCT_NAME = "$(TARGET_NAME:c99extidentifier)"; SKIP_INSTALL = YES; diff --git a/README.md b/README.md index d40a4d1..0e65f15 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # IRLPDFScanContent -Super easy `SwiftUI` & `UKKit` pakcage to scan: Images or PDF. +Super easy `SwiftUI` & `UKKit` pakcage to scan: Images or PDF. It is also a replacement for [IRLScannerViewController](https://github.com/charlymr/IRLDocumentScanner) [![🍎 Documentation](https://raw.githubusercontent.com/charlymr/IRLPDFScanContent/main/documentationicon.png)](https://irlpdfscancontent.irlmobile.com/documentation/) [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=charlymr_IRLPDFScanContent&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=charlymr_IRLPDFScanContent) [![Version](https://img.shields.io/cocoapods/v/IRLPDFScanContent.svg?style=flat)](http://cocoapods.org/pods/IRLPDFScanContent) [![Platform](https://img.shields.io/cocoapods/p/IRLPDFScanContent.svg?style=flat)](http://cocoapods.org/pods/IRLPDFScanContent) [![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage) [![licence MIT](https://shields.io/badge/license-MIT-%23373737)](https://github.com/charlymr/IRLPDFScanContent/blob/main/LICENSE) @@ -10,6 +10,16 @@ A convenient class usable from `UIKit` view controller or `SwiftUI` to scan docu **MINIMUM iOS REQUIREMENT: 13.0** + +## Migration from [IRLScannerViewController](https://github.com/charlymr/IRLDocumentScanner) +Migration from [IRLScannerViewController](https://github.com/charlymr/IRLDocumentScanner) is feasible. Please check the tutorial available in the [documentation](https://irlpdfscancontent.irlmobile.com/documentation/). + +#### You project should still work with depreciation warnings +Follow the [tutorial](https://irlpdfscancontent.irlmobile.com/documentation/) to see how to beneficiate from the new system & remove the depreciation warnings. + +One quick note, the new system support multiple scan. In this tutorial we cover how to get 1 scan. It is very straigth forward to get eveything else, check the doc. + + ## Application plist requirement As of iOS 10, you must povide a reason for using the camera in you Info.plist: @@ -41,7 +51,7 @@ let package = Package( targets: ["SPMDemo"]), ], dependencies: [ - .package(url: "git@github.com:charlymr/IRLPDFScanContent.git", from: "1.0.2"), + .package(url: "git@github.com:charlymr/IRLPDFScanContent.git", from: "1.1.0"), ], targets: [ .target( name: "SPMDemo", @@ -101,7 +111,7 @@ $ cd /path/to/MyProject $ touch CartFile ## edit CartFile: -github "charlymr/IRLPDFScanContent" ~> 1.0.2 +github "charlymr/IRLPDFScanContent" ~> 1.1.0 ``` #### Prepare diff --git a/Sources/IRLPDFScanContent/Exports.swift b/Sources/IRLPDFScanContent/Exports.swift index cd29996..74f58fc 100644 --- a/Sources/IRLPDFScanContent/Exports.swift +++ b/Sources/IRLPDFScanContent/Exports.swift @@ -18,10 +18,12 @@ public enum IRLPDFScanContentVersion: String { /// Minor Versions case v1_0 = "1.0" + case v1_1 = "1.1" /// Patch Versions case v1_0_0 = "1.0.0" case v1_0_1 = "1.0.1" case v1_0_2 = "1.0.2" + case v1_1_0 = "1.1.0" } diff --git a/Sources/IRLPDFScanContent/IRLPDFScanContent.docc/GettingStarted.md b/Sources/IRLPDFScanContent/IRLPDFScanContent.docc/GettingStarted.md index d4e85d7..759bf12 100644 --- a/Sources/IRLPDFScanContent/IRLPDFScanContent.docc/GettingStarted.md +++ b/Sources/IRLPDFScanContent/IRLPDFScanContent.docc/GettingStarted.md @@ -41,7 +41,7 @@ let package = Package( targets: ["SPMDemo"]), ], dependencies: [ - .package(url: "git@github.com:charlymr/IRLPDFScanContent.git", from: "1.0.2"), + .package(url: "git@github.com:charlymr/IRLPDFScanContent.git", from: "1.1.0"), ], targets: [ .target( name: "SPMDemo", @@ -101,7 +101,7 @@ $ cd /path/to/MyProject $ touch CartFile ## edit CartFile: -github "charlymr/IRLPDFScanContent" ~> 1.0.2 +github "charlymr/IRLPDFScanContent" ~> 1.1.0 ``` #### Prepare diff --git a/docs/data/documentation/irlpdfscancontent/gettingstarted.json b/docs/data/documentation/irlpdfscancontent/gettingstarted.json index 63c40b0..f7a0333 100644 --- a/docs/data/documentation/irlpdfscancontent/gettingstarted.json +++ b/docs/data/documentation/irlpdfscancontent/gettingstarted.json @@ -1 +1 @@ -{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Use this class in to perform a scan and get images or a PDF as result."}]},{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"MINIMUM iOS REQUIREMENT: 13.0"}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integration of this Library can be done using SPM, Cocoapods, Carthage or you can download the code and drop the “Sources\/IRLPDFScaContent” to your project."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"📚 If you drop the source code from “Sources\/IRLPDFScaContent”, you may want to remove the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":".docc folder as the documentation is intended to be nuidl for a Module."}]},{"anchor":"Info.plist-requirement","level":2,"type":"heading","text":"Info.plist requirement"},{"type":"paragraph","inlineContent":[{"type":"text","text":"As of iOS 10, you must povide a reason for using the camera in you Info.plist:"},{"type":"text","text":" "},{"type":"text","text":"Please add the following to your plist:"},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/bundleresources\/information_property_list\/nscamerausagedescription"},{"type":"text","text":" : We need the camera to scan"}]}]},{"anchor":"Swift-Package","level":2,"type":"heading","text":"Swift Package"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integrate the library via Swift Package (With Documentation)"}]},{"anchor":"In-Xcode","level":4,"type":"heading","text":"In Xcode"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Add the Package to your project, min version "},{"type":"codeVoice","code":"5.5"},{"type":"text","text":", See "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/swift_packages\/adding_package_dependencies_to_your_app"},{"type":"text","text":" for more details."}]},{"anchor":"Manually","level":4,"type":"heading","text":"Manually"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Create a Package.swift in a folder, then Drop the file on Xcode"}]},{"type":"codeListing","syntax":"swift","code":["\/\/ swift-tools-version:5.5","\/\/ The swift-tools-version declares the minimum version of Swift required to build this package.","import PackageDescription","let package = Package("," name: \"SPMDemo\","," products: ["," .library("," name: \"SPMDemo\","," targets: [\"SPMDemo\"]),"," ],"," dependencies: ["," .package(url: \"git@github.com:charlymr\/IRLPDFScanContent.git\", from: \"1.0.2\"),"," ],"," targets: ["," .target( name: \"SPMDemo\","," dependencies: ["," .product(name: \"IRLPDFScanContent\", package: \"IRLPDFScanContent\"),"," ])"," ]",")"]},{"anchor":"CocoaPods","level":2,"type":"heading","text":"CocoaPods"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integrate the library via CocoaPods"}]},{"anchor":"Install-CocoaPods","level":4,"type":"heading","text":"Install CocoaPods"},{"type":"paragraph","inlineContent":[{"type":"text","text":"if not already available:"}]},{"type":"codeListing","syntax":"bash","code":["$ [sudo] gem install cocoapods","$ pod setup"]},{"anchor":"Update-your-Podfile","level":4,"type":"heading","text":"Update your Podfile"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Change to the directory of your Xcode project, and Create and Edit your Podfile and add "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":":"}]},{"type":"codeListing","syntax":"bash","code":["$ cd \/path\/to\/MyProject","$ touch Podfile","## edit Podfile:","","platform :ios, '13.0'","","target \"YOUR APP\" do"," pod 'IRLPDFScanContent'"," use_frameworks!","end"]},{"anchor":"Prepare-project","level":4,"type":"heading","text":"Prepare project"},{"type":"paragraph","inlineContent":[{"type":"text","text":"run "},{"type":"codeVoice","code":"pod update"},{"type":"text","text":" or "},{"type":"codeVoice","code":"pod install"},{"type":"text","text":" to generate the Workspace"}]},{"type":"codeListing","syntax":"bash","code":["$ pod update"]},{"anchor":"Carthage","level":2,"type":"heading","text":"Carthage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integrate the library via Carthage."},{"type":"text","text":" "},{"type":"text","text":"For more details on Cartage and how to use it, check the "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/Carthage\/Carthage"},{"type":"text","text":" documentation"}]},{"anchor":"Install-Carthage","level":4,"type":"heading","text":"Install Carthage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Install "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/Carthage\/Carthage#installing-carthage"},{"type":"text","text":" if not already available"}]},{"anchor":"Update-your-CartFile","level":4,"type":"heading","text":"Update your CartFile"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Change to the directory of your Xcode project, and Create and Edit your CartFile and add "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":":"}]},{"type":"codeListing","syntax":"bash","code":["$ cd \/path\/to\/MyProject","$ touch CartFile","## edit CartFile:","","github \"charlymr\/IRLPDFScanContent\" ~> 1.0.2"]},{"anchor":"Prepare","level":4,"type":"heading","text":"Prepare"},{"type":"codeListing","syntax":"bash","code":["$ carthage update --use-xcframeworks "]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Drop the Carthage\/Build\/iOS "},{"type":"codeVoice","code":".xcframework"},{"type":"text","text":" in your project."}]}]}],"schemaVersion":{"major":0,"minor":1,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/irlpdfscancontent\/gettingstarted"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/GettingStarted","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A convenient class usable from "},{"type":"codeVoice","code":"UIKit"},{"type":"text","text":" view controller or "},{"type":"codeVoice","code":"SwiftUI"},{"type":"text","text":" to scan document & get "},{"type":"codeVoice","code":"UIImage"},{"type":"text","text":" or "},{"type":"codeVoice","code":"PDFDocument"},{"type":"text","text":" as result"}],"kind":"article","metadata":{"roleHeading":"Article","title":"Installation","role":"article","modules":[{"name":"IRLPDFScanContent"}]},"hierarchy":{"paths":[["doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"]]},"seeAlsoSections":[{"title":"Essentials","identifiers":["doc:\/\/com.irlmobile.IRLPDFScanContent\/tutorials\/Tutorial-Table-of-Contents","doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/About","doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/ClassicalDelegate","doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/SwiftUI"],"generated":true}],"references":{"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/IRLPDFScanContent":{"role":"symbol","title":"IRLPDFScanContent","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"IRLPDFScanContent"}],"abstract":[{"type":"text","text":"Use this class in to perform a scan an get the PDF or images as result"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"IRLPDFScanContent"}],"url":"\/documentation\/irlpdfscancontent\/irlpdfscancontent"},"https://github.com/Carthage/Carthage":{"title":"Carthage Github","titleInlineContent":[{"type":"text","text":"Carthage Github"}],"type":"link","identifier":"https:\/\/github.com\/Carthage\/Carthage","url":"https:\/\/github.com\/Carthage\/Carthage"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent":{"role":"collection","title":"IRLPDFScanContent","abstract":[{"type":"codeVoice","code":"SwiftUI"},{"type":"text","text":" & "},{"type":"codeVoice","code":"UKKit"},{"type":"text","text":" - Images or PDF scanner."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent","kind":"symbol","type":"topic","url":"\/documentation\/irlpdfscancontent"},"https://github.com/Carthage/Carthage#installing-carthage":{"title":"Carthage","titleInlineContent":[{"type":"text","text":"Carthage"}],"type":"link","identifier":"https:\/\/github.com\/Carthage\/Carthage#installing-carthage","url":"https:\/\/github.com\/Carthage\/Carthage#installing-carthage"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/ClassicalDelegate":{"role":"article","title":"Classical Delegate","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":" provide a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent\/delegate"},{"type":"text","text":" call for each action taken by the scanner. Check "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContentProtocol"},{"type":"text","text":" for more details"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/ClassicalDelegate","kind":"article","type":"topic","url":"\/documentation\/irlpdfscancontent\/classicaldelegate"},"doc://com.irlmobile.IRLPDFScanContent/tutorials/Tutorial-Table-of-Contents":{"role":"overview","title":"Meet IRLPDFScanContent","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent"},{"type":"text","text":" is a convenient way to use "},{"type":"codeVoice","code":"PDFKit"},{"type":"text","text":" in SwiftUI allowing the user to scan multiple pages and creating a PDF for you."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/tutorials\/Tutorial-Table-of-Contents","kind":"overview","type":"topic","url":"\/tutorials\/tutorial-table-of-contents"},"https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription":{"title":"NSCameraUsageDescription","titleInlineContent":[{"type":"text","text":"NSCameraUsageDescription"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/bundleresources\/information_property_list\/nscamerausagedescription","url":"https:\/\/developer.apple.com\/documentation\/bundleresources\/information_property_list\/nscamerausagedescription"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/About":{"role":"article","title":"About","abstract":[{"type":"text","text":"This project is Open source. It comes with no warranty or support."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/About","kind":"article","type":"topic","url":"\/documentation\/irlpdfscancontent\/about"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/IRLPDFScanContentProtocol":{"role":"symbol","title":"IRLPDFScanContentProtocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"IRLPDFScanContentProtocol"}],"abstract":[{"type":"text","text":"Delegate responding to various events from "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContentProtocol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"IRLPDFScanContentProtocol"}],"url":"\/documentation\/irlpdfscancontent\/irlpdfscancontentprotocol"},"https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app":{"title":"Apple Documentation","titleInlineContent":[{"type":"text","text":"Apple Documentation"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/swift_packages\/adding_package_dependencies_to_your_app","url":"https:\/\/developer.apple.com\/documentation\/swift_packages\/adding_package_dependencies_to_your_app"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/IRLPDFScanContent/delegate":{"role":"symbol","title":"delegate","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"delegate"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"IRLPDFScanContentProtocol","preciseIdentifier":"s:17IRLPDFScanContent0aB8ProtocolP"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Bew notifified of the result using a delegate"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent\/delegate","kind":"symbol","type":"topic","url":"\/documentation\/irlpdfscancontent\/irlpdfscancontent\/delegate"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/SwiftUI":{"role":"article","title":"SwiftUI","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":" has a convenient way to use "},{"type":"codeVoice","code":"PDFKit"},{"type":"text","text":" in SwiftUI allowing the user to scan multiple pages and creating a PDF for you."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/SwiftUI","kind":"article","type":"topic","url":"\/documentation\/irlpdfscancontent\/swiftui"}}} \ No newline at end of file +{"primaryContentSections":[{"kind":"content","content":[{"anchor":"Overview","level":2,"type":"heading","text":"Overview"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Use this class in to perform a scan and get images or a PDF as result."}]},{"type":"paragraph","inlineContent":[{"type":"strong","inlineContent":[{"type":"text","text":"MINIMUM iOS REQUIREMENT: 13.0"}]}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integration of this Library can be done using SPM, Cocoapods, Carthage or you can download the code and drop the “Sources\/IRLPDFScaContent” to your project."}]},{"type":"paragraph","inlineContent":[{"type":"text","text":"📚 If you drop the source code from “Sources\/IRLPDFScaContent”, you may want to remove the "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":".docc folder as the documentation is intended to be nuidl for a Module."}]},{"anchor":"Info.plist-requirement","level":2,"type":"heading","text":"Info.plist requirement"},{"type":"paragraph","inlineContent":[{"type":"text","text":"As of iOS 10, you must povide a reason for using the camera in you Info.plist:"},{"type":"text","text":" "},{"type":"text","text":"Please add the following to your plist:"},{"type":"text","text":" "},{"type":"strong","inlineContent":[{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/bundleresources\/information_property_list\/nscamerausagedescription"},{"type":"text","text":" : We need the camera to scan"}]}]},{"anchor":"Swift-Package","level":2,"type":"heading","text":"Swift Package"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integrate the library via Swift Package (With Documentation)"}]},{"anchor":"In-Xcode","level":4,"type":"heading","text":"In Xcode"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Add the Package to your project, min version "},{"type":"codeVoice","code":"5.5"},{"type":"text","text":", See "},{"type":"reference","isActive":true,"identifier":"https:\/\/developer.apple.com\/documentation\/swift_packages\/adding_package_dependencies_to_your_app"},{"type":"text","text":" for more details."}]},{"anchor":"Manually","level":4,"type":"heading","text":"Manually"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Create a Package.swift in a folder, then Drop the file on Xcode"}]},{"type":"codeListing","syntax":"swift","code":["\/\/ swift-tools-version:5.5","\/\/ The swift-tools-version declares the minimum version of Swift required to build this package.","import PackageDescription","let package = Package("," name: \"SPMDemo\","," products: ["," .library("," name: \"SPMDemo\","," targets: [\"SPMDemo\"]),"," ],"," dependencies: ["," .package(url: \"git@github.com:charlymr\/IRLPDFScanContent.git\", from: \"1.1.0\"),"," ],"," targets: ["," .target( name: \"SPMDemo\","," dependencies: ["," .product(name: \"IRLPDFScanContent\", package: \"IRLPDFScanContent\"),"," ])"," ]",")"]},{"anchor":"CocoaPods","level":2,"type":"heading","text":"CocoaPods"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integrate the library via CocoaPods"}]},{"anchor":"Install-CocoaPods","level":4,"type":"heading","text":"Install CocoaPods"},{"type":"paragraph","inlineContent":[{"type":"text","text":"if not already available:"}]},{"type":"codeListing","syntax":"bash","code":["$ [sudo] gem install cocoapods","$ pod setup"]},{"anchor":"Update-your-Podfile","level":4,"type":"heading","text":"Update your Podfile"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Change to the directory of your Xcode project, and Create and Edit your Podfile and add "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":":"}]},{"type":"codeListing","syntax":"bash","code":["$ cd \/path\/to\/MyProject","$ touch Podfile","## edit Podfile:","","platform :ios, '13.0'","","target \"YOUR APP\" do"," pod 'IRLPDFScanContent'"," use_frameworks!","end"]},{"anchor":"Prepare-project","level":4,"type":"heading","text":"Prepare project"},{"type":"paragraph","inlineContent":[{"type":"text","text":"run "},{"type":"codeVoice","code":"pod update"},{"type":"text","text":" or "},{"type":"codeVoice","code":"pod install"},{"type":"text","text":" to generate the Workspace"}]},{"type":"codeListing","syntax":"bash","code":["$ pod update"]},{"anchor":"Carthage","level":2,"type":"heading","text":"Carthage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Integrate the library via Carthage."},{"type":"text","text":" "},{"type":"text","text":"For more details on Cartage and how to use it, check the "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/Carthage\/Carthage"},{"type":"text","text":" documentation"}]},{"anchor":"Install-Carthage","level":4,"type":"heading","text":"Install Carthage"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Install "},{"type":"reference","isActive":true,"identifier":"https:\/\/github.com\/Carthage\/Carthage#installing-carthage"},{"type":"text","text":" if not already available"}]},{"anchor":"Update-your-CartFile","level":4,"type":"heading","text":"Update your CartFile"},{"type":"paragraph","inlineContent":[{"type":"text","text":"Change to the directory of your Xcode project, and Create and Edit your CartFile and add "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":":"}]},{"type":"codeListing","syntax":"bash","code":["$ cd \/path\/to\/MyProject","$ touch CartFile","## edit CartFile:","","github \"charlymr\/IRLPDFScanContent\" ~> 1.1.0"]},{"anchor":"Prepare","level":4,"type":"heading","text":"Prepare"},{"type":"codeListing","syntax":"bash","code":["$ carthage update --use-xcframeworks "]},{"type":"paragraph","inlineContent":[{"type":"text","text":"Drop the Carthage\/Build\/iOS "},{"type":"codeVoice","code":".xcframework"},{"type":"text","text":" in your project."}]}]}],"schemaVersion":{"major":0,"minor":1,"patch":0},"sections":[],"variants":[{"paths":["\/documentation\/irlpdfscancontent\/gettingstarted"],"traits":[{"interfaceLanguage":"swift"}]}],"identifier":{"url":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/GettingStarted","interfaceLanguage":"swift"},"abstract":[{"type":"text","text":"A convenient class usable from "},{"type":"codeVoice","code":"UIKit"},{"type":"text","text":" view controller or "},{"type":"codeVoice","code":"SwiftUI"},{"type":"text","text":" to scan document & get "},{"type":"codeVoice","code":"UIImage"},{"type":"text","text":" or "},{"type":"codeVoice","code":"PDFDocument"},{"type":"text","text":" as result"}],"kind":"article","metadata":{"roleHeading":"Article","title":"Installation","role":"article","modules":[{"name":"IRLPDFScanContent"}]},"hierarchy":{"paths":[["doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"]]},"seeAlsoSections":[{"title":"Essentials","identifiers":["doc:\/\/com.irlmobile.IRLPDFScanContent\/tutorials\/Tutorial-Table-of-Contents","doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/About","doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/ClassicalDelegate","doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/SwiftUI"],"generated":true}],"references":{"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/IRLPDFScanContent":{"role":"symbol","title":"IRLPDFScanContent","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"kind":"identifier","text":"IRLPDFScanContent"}],"abstract":[{"type":"text","text":"Use this class in to perform a scan an get the PDF or images as result"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"IRLPDFScanContent"}],"url":"\/documentation\/irlpdfscancontent\/irlpdfscancontent"},"https://github.com/Carthage/Carthage":{"title":"Carthage Github","titleInlineContent":[{"type":"text","text":"Carthage Github"}],"type":"link","identifier":"https:\/\/github.com\/Carthage\/Carthage","url":"https:\/\/github.com\/Carthage\/Carthage"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent":{"role":"collection","title":"IRLPDFScanContent","abstract":[{"type":"codeVoice","code":"SwiftUI"},{"type":"text","text":" & "},{"type":"codeVoice","code":"UKKit"},{"type":"text","text":" - Images or PDF scanner."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent","kind":"symbol","type":"topic","url":"\/documentation\/irlpdfscancontent"},"https://github.com/Carthage/Carthage#installing-carthage":{"title":"Carthage","titleInlineContent":[{"type":"text","text":"Carthage"}],"type":"link","identifier":"https:\/\/github.com\/Carthage\/Carthage#installing-carthage","url":"https:\/\/github.com\/Carthage\/Carthage#installing-carthage"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/ClassicalDelegate":{"role":"article","title":"Classical Delegate","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":" provide a "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent\/delegate"},{"type":"text","text":" call for each action taken by the scanner. Check "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContentProtocol"},{"type":"text","text":" for more details"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/ClassicalDelegate","kind":"article","type":"topic","url":"\/documentation\/irlpdfscancontent\/classicaldelegate"},"doc://com.irlmobile.IRLPDFScanContent/tutorials/Tutorial-Table-of-Contents":{"role":"overview","title":"Meet IRLPDFScanContent","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent"},{"type":"text","text":" is a convenient way to use "},{"type":"codeVoice","code":"PDFKit"},{"type":"text","text":" in SwiftUI allowing the user to scan multiple pages and creating a PDF for you."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/tutorials\/Tutorial-Table-of-Contents","kind":"overview","type":"topic","url":"\/tutorials\/tutorial-table-of-contents"},"https://developer.apple.com/documentation/bundleresources/information_property_list/nscamerausagedescription":{"title":"NSCameraUsageDescription","titleInlineContent":[{"type":"text","text":"NSCameraUsageDescription"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/bundleresources\/information_property_list\/nscamerausagedescription","url":"https:\/\/developer.apple.com\/documentation\/bundleresources\/information_property_list\/nscamerausagedescription"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/About":{"role":"article","title":"About","abstract":[{"type":"text","text":"This project is Open source. It comes with no warranty or support."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/About","kind":"article","type":"topic","url":"\/documentation\/irlpdfscancontent\/about"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/IRLPDFScanContentProtocol":{"role":"symbol","title":"IRLPDFScanContentProtocol","fragments":[{"kind":"keyword","text":"protocol"},{"kind":"text","text":" "},{"kind":"identifier","text":"IRLPDFScanContentProtocol"}],"abstract":[{"type":"text","text":"Delegate responding to various events from "},{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContentProtocol","kind":"symbol","type":"topic","navigatorTitle":[{"kind":"identifier","text":"IRLPDFScanContentProtocol"}],"url":"\/documentation\/irlpdfscancontent\/irlpdfscancontentprotocol"},"https://developer.apple.com/documentation/swift_packages/adding_package_dependencies_to_your_app":{"title":"Apple Documentation","titleInlineContent":[{"type":"text","text":"Apple Documentation"}],"type":"link","identifier":"https:\/\/developer.apple.com\/documentation\/swift_packages\/adding_package_dependencies_to_your_app","url":"https:\/\/developer.apple.com\/documentation\/swift_packages\/adding_package_dependencies_to_your_app"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/IRLPDFScanContent/delegate":{"role":"symbol","title":"delegate","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"delegate"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"IRLPDFScanContentProtocol","preciseIdentifier":"s:17IRLPDFScanContent0aB8ProtocolP"},{"kind":"text","text":"?"}],"abstract":[{"type":"text","text":"Bew notifified of the result using a delegate"}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/IRLPDFScanContent\/delegate","kind":"symbol","type":"topic","url":"\/documentation\/irlpdfscancontent\/irlpdfscancontent\/delegate"},"doc://com.irlmobile.IRLPDFScanContent/documentation/IRLPDFScanContent/SwiftUI":{"role":"article","title":"SwiftUI","abstract":[{"type":"reference","isActive":true,"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent"},{"type":"text","text":" has a convenient way to use "},{"type":"codeVoice","code":"PDFKit"},{"type":"text","text":" in SwiftUI allowing the user to scan multiple pages and creating a PDF for you."}],"identifier":"doc:\/\/com.irlmobile.IRLPDFScanContent\/documentation\/IRLPDFScanContent\/SwiftUI","kind":"article","type":"topic","url":"\/documentation\/irlpdfscancontent\/swiftui"}}} \ No newline at end of file