Skip to content

Latest commit

 

History

History
68 lines (39 loc) · 3.1 KB

README.md

File metadata and controls

68 lines (39 loc) · 3.1 KB

AcknowList

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

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

Platform iOS Swift 5 Build Status Swift Package Manager 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. Run pod install.
  3. Add the Pods-{target}-acknowledgements.plist file generated by CocoaPods in Pods/Target Support Files/Pods-{target}/ to your main target (drag and drop the file in your Xcode project). Don’t copy the file, leave Copy items if needed unchecked.

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 5, requires iOS 8.0 or tvOS 9.0 and above, Xcode 10.2 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.