Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
vtourraine authored Feb 23, 2021
1 parent 888a331 commit 0f14a83
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VTAcknowledgementsViewController

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/VTAcknowledgementsViewController.svg)
[![Build Status](https://travis-ci.org/vtourraine/VTAcknowledgementsViewController.svg?branch=master)](https://travis-ci.org/vtourraine/VTAcknowledgementsViewController)
Expand All @@ -14,21 +14,21 @@ _Also available in Swift with [AcknowList](https://github.com/vtourraine/AcknowL
## 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 12 languages

## How to Install
## Installation

CocoaPods is the most common solution to install this library.

1. Add `pod 'VTAcknowledgementsViewController'` to your `Podfile`.
2. Run `pod install`.
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.
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).

## Initialization

Expand Down Expand Up @@ -73,13 +73,13 @@ NSString *localizedTitle = [VTLocalization localizedTitle];
[button setTitle:localizedTitle forState:UIControlStateNormal];
```
By default, the `VTAcknowledgementsViewController` uses the “grouped” table view style. You can choose a different style:
By default, `VTAcknowledgementsViewController` uses the “grouped” table view style. You can choose a different style:
``` objc
viewController = [[VTAcknowledgementsViewController alloc] initWithAcknowledgements:@[] style:UITableViewStylePlain];
```

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

Expand All @@ -93,7 +93,7 @@ VTAcknowledgementsViewController supports iOS 9.0 or tvOS 9.0 and above, and req

## Credits

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

## License

Expand Down

0 comments on commit 0f14a83

Please sign in to comment.