Code Monkey home page Code Monkey logo

glimmer's Introduction

Glimmer

Glimmer is a simple Swift library for macOS application update checking for apps distributed via GitHub releases. It is available as a Swift Package.


Usage

The library's functionality can be accessed through GlimmerUpdater, which is initialized with the repository owner and name. Calling getLatestRelease() will yield a Combine Publisher that resolves to a GlimmerRelease, which contains information about the most recent published release. Importantly, GlimmerRelease contains a tag field, which matches the git repository tag that was used to generate the release. Your application can compare this tag to the current version of the application, and determine if and how to alert the user.

Preferences

Your application decides whether or not to allow the end user to enable or disable update checks, and whether or not to allow the user to "skip" a particular update version.

Important Notes

Glimmer does not install application updates. It not meant to replicate the functionality of auto-update libraries such as Sparkle. It merely provides the methods to check if an update is available, and the means to inform the user of how to navigate to and download the latest version. Glimmer does not include built-in methods for notifying the user that an update is available, and it does not maintain any persistent history of the last update check or ignored versions.

glimmer's People

Contributors

jashephe avatar

Watchers

 avatar  avatar

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.