ResourceKit

A Swift-native iOS framework for working with files and file types.

Usage

Add the following to your Swift source code file:

import ResourceKit

Installation

ResourceKit currently supports the following popular package managers:

Swift Package Manager (SPM): Apple's official solution for managing Swift packages;
CocoaPods: A centralized dependency manager, written in Ruby, for Swift and Objective-C projects;
Carthage: A decentralized dependency manager, written in Swift, for Swift and Objective-C projects.

If package management is not your thing, manual installation instructions are also provided.

For more information on Swift package management or for help in selecting a particular package manager for your project, refer to the following articles:

Swift Package Manager vs CocoaPods vs Carthage for All Platforms: Dec 07, 2018
Choosing the Right iOS Dependency Manager: Oct 23, 2018

Swift Package Manager

Add the following to your Package.swift file:

// swift-tools-version:4.0
// The swift-tools-version declares the minimum version of Swift required to build this package.

import PackageDescription

let package = Package(
    // ... your project details
    dependencies: [
        // As a required dependency
        .package(url: "https://github.com/djrlj694/ResourceKit.git", majorVersion: 1)
    ],
    testDependencies: [
        // As a test dependency
        .package(url: "https://github.com/djrlj694/ResourceKit.git", majorVersion: 1)
    ]
)

CocoaPods

Add the following to your Podfile:

# CocoaPods
pod 'ResourceKit', '~> 1.0.0'

Carthage

Add the following to your Cartfile (package dependency) or Cartfile.private (development dependency):

github "djrlj694/ResourceKit" ~> 1.0.0

Manual

Clone or download the ResourceKit repository.
Copy the ResourceKit folder to your Xcode project.
Enable the following options:
- Copy items if needed
- Create groups

Documentation

Documentation for the project can be found here.

Information on how the documentation was generated and hosted can be found in the blog: Generate & Host your iOS Documentation.

Known Issues

Currently, there are no known issues. If you discover any, please kindly submit a pull request.

Contributing

Code and codeless (e.g., documentation) contributions toward improving ResourceKit are welcome. See CONTRIBUTING.md for more information on how to become a contributor.

License

ResourceKit is released under the MIT License.

References

See REFERENCES.md for a list of sources that I found helpful or inspirational when learning new topics, troubleshooting bugs, authoring documentation, etc.