/AcknowList

View controller listing CocoaPods acknowledgements

Primary LanguageSwiftMIT LicenseMIT

AcknowList

Ready to use “Acknowledgements”/“Licenses”/“Credits” view controller for CocoaPods.

Written in Swift 4 (for Objective-C, you can use VTAcknowledgementsViewController).

Platform iOS Swift 4 Build Status CocoaPods compatible MIT license

iPhone screenshot 1 iPhone screenshot 2

How to Install

This project is only useful if you use CocoaPods, so let’s assume that you’re indeed using CocoaPods.

  1. Add pod 'AcknowList' in your Podfile.
  2. Import the Pods-acknowledgements.plist file from the generated Pods/Target Support Files folder to your main app project (so you need to run pod install at least once before using this pod; don’t copy the file itself, just add a reference).
    This file is generated at Pods/Target Support Files/Pods-{project}/Pods-{project}-acknowledgements.plist.

How to Use

The AcknowListViewController instance is usually pushed to an existing UINavigationController.

let viewController = AcknowListViewController()
navigationController?.pushViewController(viewController, animated: true)

Customization

If your .plist file is named something other than Pods-acknowledgements.plist (e.g. if you’re using custom build targets), you can initialize the view controller with a custom path.

let viewController = AcknowListViewController(fileNamed: "Pods-AcknowExample-acknowledgements")
let path = Bundle.main.path(forResource: "Pods-AcknowExample-acknowledgements", ofType: "plist")
let viewController = AcknowListViewController(acknowledgementsPlistPath: path)

Apple TV

AcknowList is also compatible with tvOS for Apple TV apps.

Apple TV screenshot 1 Apple TV screenshot 2

Requirements

AcknowList is written in Swift 4, requires iOS 8.0 or tvOS 9.0 and above, Xcode 9.0 and above.

Credits

AcknowList was created by Vincent Tourraine, and improved by a growing list of contributors.

License

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