|
1 | 1 | ABReleaseNotesViewController |
2 | 2 | ==== |
3 | 3 |
|
4 | | -Lorem ipsum dolor sit amet. |
| 4 | +`ABReleaseNotesViewController` is an easy-to-use, reasonably attractive way to display your application's release notes in-app. This project was inspired by [https://github.com/iGriever/TWSReleaseNotesView](TWSReleaseNotesView). I've used `TWSReleaseNotesView` in the past, and it was great, but it hasn't been updated in a few years. |
| 5 | + |
| 6 | + |
| 7 | + |
| 8 | +Quickstart |
| 9 | +==== |
| 10 | + |
| 11 | +Create your release notes object in your init method, or in `-viewDidLoad`: |
| 12 | + |
| 13 | + - (void)viewDidLoad { |
| 14 | + [super viewDidLoad]; |
| 15 | + |
| 16 | + self.releaseNotes = [ABReleaseNotesViewController releaseNotesControllerWithAppIdentifier:@"329380089" title:NSLocalizedString(@"Release Notes", @"")]; |
| 17 | + } |
| 18 | + |
| 19 | +After your view appears, begin checking for updates. If an update is available, you may present the view controller immediately, as depicted below: |
| 20 | + |
| 21 | + [self.releaseNotes checkForUpdates:^(BOOL updated) { |
| 22 | + if (updated) { |
| 23 | + [self presentViewController:self.releaseNotes animated:YES completion:nil]; |
| 24 | + } |
| 25 | + }]; |
| 26 | + |
| 27 | +Additionally, you could present an alert or some sort of non-modal user interface to the user informing them that they can read release notes if desired. |
| 28 | + |
| 29 | +System Requirements |
| 30 | +==== |
| 31 | + |
| 32 | +iOS 9.0 and above. Should be compatible with tvOS, but I haven't tried it there, yet. Supporting iOS 8 should be relatively straightforward, if you're willing to deal with some Auto Layout annoyances that are rendered trivial by `UIStackView`. |
| 33 | + |
| 34 | +Issues, Pull Requests, etc. |
| 35 | +==== |
| 36 | + |
| 37 | +Issues, bug fixes, and new features are always welcome. Priority will be given to issues that are accompanied by patches, but I will do my best to stay on top of problems with the code. |
| 38 | + |
| 39 | +Credits |
| 40 | +==== |
| 41 | + |
| 42 | +* Created by [Aaron Brethorst](http://www.twitter.com/aaronbrethorst). |
| 43 | +* Inspired by [TWSReleaseNotesView](https://github.com/iGriever/TWSReleaseNotesView), by [Matteo Lallone](https://twitter.com/iGriever) and [Gianluca Divisi](https://twitter.com/gianlucadivisi). |
5 | 44 |
|
6 | 45 | MIT License |
7 | 46 | ==== |
|
0 commit comments