Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
vtourraine committed Feb 23, 2021
1 parent 574d5fd commit 61f9aa6
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
Binary file added Images/AcknowList-Apple-TV.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# AcknowList

Acknowledgements screen displaying a list of licences, for example from [CocoaPods](https://cocoapods.org) dependencies.
Acknowledgements screen displaying a list of licenses, for example from [CocoaPods](https://cocoapods.org) dependencies.

![Platform iOS](https://img.shields.io/cocoapods/p/AcknowList.svg)
![Swift 5](https://img.shields.io/badge/Swift-5-blue.svg)
Expand All @@ -11,26 +11,26 @@ Acknowledgements screen displaying a list of licences, for example from [CocoaPo

_Also available in Objective-C with [VTAcknowledgementsViewController](https://github.com/vtourraine/VTAcknowledgementsViewController)._

![AcknowList screenshots](AcknowList.png)
![AcknowList screenshots](Images/AcknowList.png)

## Features

- Automatically load acknowledgments from CocoaPods-generated file
- Remove unnecessary line breaks from licences for better text wrapping
- Remove unnecessary line breaks from licenses for better text wrapping
- Optional list header and footer
- Tappable links in header, footer, and acknowledgment text
- Storyboard support
- Dark Mode support
- Dynamic Type support
- Localized in 13 languages

## How to Install
## Installation

### CocoaPods

1. Add `pod 'AcknowList'` to 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.
3. 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 in your Xcode project (don’t copy the file, leave `Copy items if needed` unchecked).

### Swift Package Manager

Expand Down Expand Up @@ -88,21 +88,21 @@ By default, `AcknowListViewController` uses the “grouped” table view style.
let viewController = AcknowListViewController(plistPath: path, style: .plain)
```

If you need to further customize the appearance or behavior of this pod, feel free to subclass its classes.
If you need to further customize the appearance or behavior of this library, feel free to subclass its classes.

## Apple TV

AcknowList is also compatible with tvOS for Apple TV apps.

<img alt="Apple TV screenshot 1" src="https://user-images.githubusercontent.com/886053/37403710-07901b2e-2790-11e8-975f-b779fcfc3fbe.png" width="300px"> <img alt="Apple TV screenshot 2" src="https://user-images.githubusercontent.com/886053/37403711-07c83d38-2790-11e8-9f2e-84fe2d5f6bad.png" width="300px">
![AcknowList Apple TV screenshots](Images/AcknowList-Apple-TV.png)

## Requirements

AcknowList is written in Swift 5, requires iOS 9.0 or tvOS 9.0 and above, Xcode 11 and above.

## Credits

AcknowList was created by [Vincent Tourraine](http://www.vtourraine.net), and improved by a growing [list of contributors](https://github.com/vtourraine/AcknowList/contributors).
AcknowList was created by [Vincent Tourraine](https://www.vtourraine.net), and improved by a growing [list of contributors](https://github.com/vtourraine/AcknowList/contributors).

## License

Expand Down

0 comments on commit 61f9aa6

Please sign in to comment.