Skip to content

Swift utilities for scanning barcodes with Apple's Vision Framework.

License

Notifications You must be signed in to change notification settings

CypherPoet/SwiftBarcodeScanningUtils

Repository files navigation

SwiftBarcodeScanningUtils

Twitter: @cypher_poet

Swift utilities for scanning barcodes with Apple's Vision Framework.

Installation

Xcode Projects

Select File -> Swift Packages -> Add Package Dependency and enter https://github.com/CypherPoet/SwiftBarcodeScanningUtils.

Swift Package Manager Projects

You can add SwiftBarcodeScanningUtils as a package dependency in your Package.swift file:

let package = Package(
    //...
    dependencies: [
        .package(
            name: "SwiftBarcodeScanningUtils",
            url: "https://github.com/CypherPoet/SwiftBarcodeScanningUtils",
            .exact("0.0.1")
        ),
    ],
    //...
)

From there, refer to SwiftBarcodeScanningUtils as a "target dependency" in any of your package's targets that need it.

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
          "SwiftBarcodeScanningUtils",
        ],
        ...
    ),
    ...
]

Then simply import SwiftBarcodeScanningUtils wherever you’d like to use it.

Contributing

Contributions to SwiftBarcodeScanningUtils are most welcome. Check out some of the issue templates for more info.

💻 Developing

Requirements

  • Xcode 13.0+

📜 Creating & Building Documentation

Documentation is built with Xcode's DocC. See Apple's guidance on how to build, run, and create DocC content.

For now, the best way to view the docs is to open the project in Xcode and run the Build Documentation command. At some point in the future, I'm hoping to leverage the tooling the develops for generating/hosting DocC documentation. (Please feel free to let me know if you have any ideas or tooling recommendations around this 🙂).

🏷 License

SwiftBarcodeScanningUtils is available under the MIT license. See the LICENSE file for more info.