Latest 0.1.1
Homepage https://github.com/aaronbrethorst/ABReleaseNotesViewController
License MIT
Platforms ios 9.0, requires ARC
Frameworks UIKit
Authors

Since iOS 7, users have been opted in to automatic updates of their apps from the App Store. This is great for ensuring that our users are always on the latest versions of our products, but it means that it can be much more difficult to tell them about what’s new and different in our updates. ABReleaseNotesViewController fixes that by displaying your app’s release notes from the App Store inside your app on the first launch after an update.

ABReleaseNotesViewController is an easy-to-use, reasonably attractive way to display your application’s release notes from the App Store inside your app. This project was inspired by https://github.com/iGriever/TWSReleaseNotesView. I’ve used TWSReleaseNotesView in the past, and it was great, but it hasn’t been updated in a few years.

Animated GIF demonstrating the project

Quickstart

Create your release notes object in your init method, or in -viewDidLoad:

- (void)viewDidLoad {
  [super viewDidLoad];

  self.releaseNotes = [ABReleaseNotesViewController releaseNotesControllerWithAppIdentifier:@"329380089" title:NSLocalizedString(@"Release Notes", @"")];
}

After your view appears, begin checking for updates. If an update is available, you may present the view controller immediately, as depicted below:

[self.releaseNotes checkForUpdates:^(BOOL updated) {
  if (updated) {
      [self presentViewController:self.releaseNotes animated:YES completion:nil];
  }
}];

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.

System Requirements

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.

Issues, Pull Requests, etc.

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.

TODOs

  • [ ] Cocoapods
  • [ ] Carthage
  • [ ] Optional Markdown formatting of release notes

Credits

MIT License

The MIT License (MIT)

Copyright (c) 2016 Aaron Brethorst

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Latest podspec

{
    "name": "ABReleaseNotesViewController",
    "version": "0.1.1",
    "summary": "The easiest way to display your App Store release notes inside your app after an update.",
    "description": "Since iOS 7, users have been opted in to automatic updates of their apps from the App Store. This is great for ensuring that our users are always on the latest versions of our products, but it means that it can be much more difficult to tell them about what's new and different in our updates. ABReleaseNotesViewController fixes that by displaying your app's release notes from the App Store inside your app on the first launch after an update.",
    "homepage": "https://github.com/aaronbrethorst/ABReleaseNotesViewController",
    "screenshots": "https://s3.amazonaws.com/cocoacontrols_production/uploads/control_image/image/8575/rel.jpg",
    "license": "MIT",
    "authors": {
        "Aaron Brethorst": "[email protected]"
    },
    "source": {
        "git": "https://github.com/aaronbrethorst/ABReleaseNotesViewController.git",
        "tag": "0.1.1"
    },
    "social_media_url": "https://twitter.com/aaronbrethorst",
    "platforms": {
        "ios": "9.0"
    },
    "requires_arc": true,
    "source_files": "ABReleaseNotesViewController/**/*",
    "public_header_files": "ABReleaseNotesViewController/**/*.h",
    "frameworks": "UIKit"
}

Pin It on Pinterest

Share This