CoreHapticsUtils

Utilities for using Core Haptics in iOS projects.

Installation

Xcode Projects

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

Swift Package Manager Projects

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

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

From there, refer to the CoreHapticsUtils "product" delivered by the CypherPoetCoreHapticsUtils "package" inside of any of your project's target dependencies:

targets: [
    .target(
        name: "YourLibrary",
        dependencies: [
            .product(
                name: "CoreHapticsUtils",
                package: "CypherPoetCoreHapticsUtils"
            ),
        ],
        ...
    ),
    ...
]

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

Contributing

Contributions to CypherPoetCoreHapticsUtils 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

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