{"id":15055404,"url":"https://github.com/vtourraine/acknowlist","last_synced_at":"2026-04-18T14:04:59.765Z","repository":{"id":1572288,"uuid":"41498076","full_name":"vtourraine/AcknowList","owner":"vtourraine","description":"Acknowledgements screen displaying a list of licenses, for example from CocoaPods and Swift Package Manager dependencies.","archived":false,"fork":false,"pushed_at":"2025-02-02T15:54:23.000Z","size":1472,"stargazers_count":842,"open_issues_count":4,"forks_count":63,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-14T18:02:11.611Z","etag":null,"topics":["cocoapods","ios","macos","spm","swift","swiftui","tvos","uikit","watchos"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vtourraine.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-08-27T16:23:11.000Z","updated_at":"2025-05-12T15:59:34.000Z","dependencies_parsed_at":"2022-08-06T11:00:05.354Z","dependency_job_id":"e62a981b-334e-455f-8ec9-8ac0b92b233e","html_url":"https://github.com/vtourraine/AcknowList","commit_stats":{"total_commits":343,"total_committers":22,"mean_commits":"15.590909090909092","dds":"0.16326530612244894","last_synced_commit":"01442976e0c401af9c3d7983c9323bfa92723ea1"},"previous_names":[],"tags_count":39,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtourraine%2FAcknowList","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtourraine%2FAcknowList/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtourraine%2FAcknowList/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vtourraine%2FAcknowList/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vtourraine","download_url":"https://codeload.github.com/vtourraine/AcknowList/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254198453,"owners_count":22030964,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cocoapods","ios","macos","spm","swift","swiftui","tvos","uikit","watchos"],"created_at":"2024-09-24T21:41:48.824Z","updated_at":"2026-04-18T14:04:59.696Z","avatar_url":"https://github.com/vtourraine.png","language":"Swift","funding_links":[],"categories":[],"sub_categories":[],"readme":"# AcknowList\n\nAcknowledgements screen displaying a list of licenses, for example from [CocoaPods](https://cocoapods.org) and [Swift Package Manager](https://swift.org/package-manager/) dependencies.\n\n![Platform iOS tvOS watchOS macOS visionOS](https://img.shields.io/cocoapods/p/AcknowList.svg)\n[![Build \u0026 Test](https://github.com/vtourraine/AcknowList/actions/workflows/ios.yml/badge.svg)](https://github.com/vtourraine/AcknowList/actions/workflows/ios.yml)\n![Swift 5](https://img.shields.io/badge/Swift-5-blue.svg)\n![Swift Package Manager](https://img.shields.io/badge/support-Swift_Package_Manager-orange.svg)\n[![CocoaPods compatible](https://img.shields.io/cocoapods/v/AcknowList.svg)](https://cocoapods.org/pods/AcknowList)\n[![MIT license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/vtourraine/AcknowList/raw/master/LICENSE)\n\n_Also available in Objective-C with [VTAcknowledgementsViewController](https://github.com/vtourraine/VTAcknowledgementsViewController)._\n\n![AcknowList screenshots](Sources/AcknowList/AcknowList.docc/Resources/acknowlist@2x.png)\n\n## Features\n\n- Load acknowledgments from CocoaPods-generated files (`Pods-###-acknowledgements.plist`)\n- Load acknowledgments from Swift Package Manager files (`Package.resolved`)\n- Fetch missing SPM licenses from GitHub API\n- Remove unnecessary line breaks from licenses for better text wrapping\n- Optional list header and footer\n- Tappable links in header, footer, and acknowledgment text\n- Storyboard support\n- Dark Mode support\n- Dynamic Type support\n- Localized in 13 languages\n- UIKit and SwiftUI interfaces\n\n## Installation\n\n### CocoaPods\n\n1. Add `pod 'AcknowList'` to your `Podfile`.\n2. Run `pod install`.\n3. Add the `Pods-#target#-acknowledgements.plist` file generated by CocoaPods to your main target: drag and drop the file from the `Pods/Target Support Files/Pods-#target#/` folder to your Xcode project (don’t copy the file, leave `Copy items if needed` unchecked).\n\n### Swift Package Manager\n\nAcknowList can be installed with the [Swift Package Manager](https://swift.org/package-manager/) (requires Xcode 12 for localized resources).\n\n1. Click on `File` → `Add Packages…`.\n2. Enter `https://github.com/vtourraine/AcknowList`.\n3. Select the version you’d like to use.\n4. Add the `Package.resolved` file generated by Xcode to your main target. Drag and drop the file from the folder to your Xcode project (don’t copy the file, leave `Copy items if needed` unchecked).\n    - For single Xcode projects, the file is in `[appName].xcodeproj/project.xcworkspace/xcshareddata/swiftpm/`\n    - For Xcode workspaces (for instance with CocoaPods), the file is in `[appName].xcworkspace/xcshareddata/swiftpm/`\n\n## Initialization\n\nThe `AcknowListViewController` instance is usually pushed to an existing `UINavigationController`.\n\n``` swift\nlet viewController = AcknowListViewController()\nnavigationController.pushViewController(viewController, animated: true)\n```\n\nBy default, the controller will try to load acknowledgements from a CocoaPods plist file (by guessing its location based on the bundle name), as well as from a `Package.resolved` file.\n \n You can also initialize the view controller with a custom file name or URL.\n\n``` swift\nlet viewController = AcknowListViewController(fileNamed: \"Pods-AcknowExample-acknowledgements\")\n```\n\n``` swift\nlet url = Bundle.main.url(forResource: \"Pods-AcknowExample-acknowledgements\", withExtension: \"plist\")\nlet viewController = AcknowListViewController(plistFileURL: url)\n```\n\nIf you want to include licenses that are not part of a `.plist` or `.resolved` file, you can create new `Acknow` instances, and use them for the acknowledgements array of the controller.\n\n``` swift\nlet acknow = Acknow(title: \"...\", text: \"...\")\nlet viewController = AcknowListViewController(acknowledgements: [acknow])\n```\n\n## Customization\n\nThe controller can also display a header and a footer. By default, they are loaded from the generated `plist` file, but you can also directly change the properties values.\n\n``` swift\nviewController.headerText = \"We love open source software.\"\nviewController.footerText = \"Powered by CocoaPods and SPM\"\n```\n\nThe controller title is a localized value for “acknowledgements”. You might want to use this localized value for the button presenting the controller.\n\n``` swift\nbutton.setTitle(AcknowLocalization.localizedTitle(), for: .normal)\n```\n\nBy default, `AcknowListViewController` uses the “grouped” table view style. You can choose a different style:\n\n``` swift\nlet viewController = AcknowListViewController(plistFileURL: url, style: .plain)\n```\n\nIf you need to further customize the appearance or behavior of this library, feel free to subclass its classes.\n\n## SwiftUI\n\nAcknowList now offers a SwiftUI interface, which supports all the major platforms.\n\nInstantiate a `AcknowListSwiftUIView` with a path to the `plist` file, or with an array of `Acknow` instances, and present this view from a `NavigationView`.\n\n## Platforms\n\n| Platform | UIKit | SwiftUI |\n|:--|:--|:--|\n| 📱 | iOS 9.0+ | iOS 13.0+ |\n| 📺 | tvOS 9.0+ | tvOS 13.0+ |\n| 🥽 | visionOS 1.0+ | visionOS 1.0+ |\n| ⌚️ | *not supported* | watchOS 7.0+ |\n| 💻 | *not supported* | macOS 10.15+ |\n\n⚠️ If you install AcknowList with CocoaPods or Swift Package Manager, it will require iOS 13 and tvOS 13. To support earlier versions, please import this library manually, and ignore the SwiftUI classes. Alternatively, use [VTAcknowledgementsViewController](https://github.com/vtourraine/VTAcknowledgementsViewController) instead.\n\n## Requirements\n\nAcknowList is written in Swift 5, and requires Xcode 12 and above.\n\n## Credits\n\nAcknowList was created by [Vincent Tourraine](https://www.vtourraine.net), and improved by a growing [list of contributors](https://github.com/vtourraine/AcknowList/contributors).\n\n## License\n\nAcknowList is available under the MIT license. See the `LICENSE.txt` file for more info.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtourraine%2Facknowlist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvtourraine%2Facknowlist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvtourraine%2Facknowlist/lists"}