Giter Club home page Giter Club logo

basicupdater's Introduction

BasicUpdater

Prompt users to download updates for you Mac app using GitHub Releases

Note: This package only opens a download link to the update - the user will still have to install the update themselves.

Supports macOS โ‰ฅ 10.15

Features

  • Prompt users to download new updates when they release
  • Allow the user to skip specific versions, or turn on/off automatic updates
  • Define the semantics for what release constitutes a "new version", and which asset to use

Installation

To add BasicUpdater to your app, go to File -> Add Packages... in Xcode, then enter this project's URL into the search field (https://github.com/michaeljberk/BasicUpdater)

Documentation

Documentation can be found at https://michaeljberk.github.io/BasicUpdater/documentation/basicupdater/

Why not use Sparkle?

Sparkle is a great way to provide automatically download and install app updates, but can sometimes be a bit unweildy for simpler projects. Since it installs the app update (instead of just downloading the update), it requires more setup (such as generating a signing key for updates). Additionally, it requires the user to create and appcast to publish updates to users, which can be difficult for certain workflows. In contrast, BasicUpdater requires less extra setup, and uses GitHub Release as a simple mechanism to provide new releases without the need to host and update an appcast.

If you're dealing with a large-scale app, I would still recommend Sparkle as the better choice - it offers a better experience by automatically installing the app, and has more customization options. BasicUpdater is better suited to smaller apps, projects that already use GitHub Releases, or (such as my case when building this project), providing beta updates outside of TestFlight.

Acknowledgements

I'd like to thank Junyu Kuang, the developer of Spring for Twitter/Mona for Mastodon, which (I believe) uses a similar mechanism for delivering beta updates.

basicupdater's People

Contributors

michaeljberk avatar

Watchers

 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.