Code Monkey home page Code Monkey logo

freshair's Introduction

Fresh Air

Fresh Air is an application update library. It is designed check a remote location for application updates and if updates are available, prompt the user to upgrade the application. When the new version of the application is started, a dialog can be presented that show case the new features available to the user.

Update Checks

Fresh Air supports checking iTunes for a new version, or checking a remotely hosted release_notes.json file.

let upgradeManager = RZFUpgradeManager(appStoreID:"ANAPPID")
upgradeManager.checkForNewUpdate()

This will check the iTunes for an app with the specified ID, and present a dialog if an update exists. See RZFUpgradeManager for details on the UI presentation

Release Note Presentation

Fresh Air also supports presenting release notes as a series of paging images with a title and description to introduce users to the new features included in an app update. This is managed by a set of feature keys specified in a release_notes.json file that is included in the application bundle. This file resides in a bundle that includes all of the assets needed for presentation. The feature keys are expanded into an image, a title, and a description via [UIImage imageNamed:$key], and the localization keys $key.title and $key.description. The usual asset lookup rules apply, so if different images are desired on iPhone vs iPad, use the ~iphone and ~ipad suffix. If localized images are desired, make sure that the images are only placed in the .lproj directories, and not in the top level directory.

Update Prompt Customization

Fresh Air comes with english localization for the update prompt. This can be customized by adding the localized keys from FreshAirUpdate.strings to your application's main bundle's Localizable.strings file. To configure an image, add an image named freshair_update to the bundle.

Release Notes

The release_notes.json file describes the version history of the application. Every release entry contains any number of 'feature' keys to denote marketing features. There is an Example of the release note file and a JSON Schema file that can be used to validate your releases_notes.json file.

Installation

To install using CocoaPods, include the 'FreshAir' cocoapod.

pod 'FreshAir'

If you only want the remote app check, use:

pod 'FreshAir/AppStoreCheck'

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.