Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

A simple and lightweight Swift library to better present release notes in iOS, iPadOS and visionOS apps

License

Notifications You must be signed in to change notification settings

TheiPhoneDev/UpdateKit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

History

40 Commits

Repository files navigation

UpdateKit

A simple and lightweight Swift library to better present release notes in iOS, iPadOS and visionOS apps.

Swift iOS iPadOS visionOS

Requirements

UpdateKit requires iOS 15.0 and visionOS 1.0

What is update kit ?

UpdateKit is a simple and lightweight Swift library that simplifies update screens. As a developer I find myself to have to write release notes, and sometime I don't show it in the best way possible to the users. One-time update screen are the best way to show our users the new version's changes and let them know what's new and what's been fixed.

UpdateKit structure

UpdateKit is inspired to Apple update screens, which can be seen in iOS built-in apps. I wanted to create a simple structure that is flexible and also customizable and can be suited to the developer's needs.

Features ✨

  • Customizable cells
  • Native UI
  • Integration with iOS, iPadOS and visionOS
  • Attach Views to show what changes have been made
  • Thread-safe (this means no data race) by using the Sendable protocol

Usage

To use UpdateKit, first of all:

 import UpdateKit

in your project. You can implement it as SPM (Swift Package Manager).

  • Go to the UpdateNotes.swift file and edit the updateNotes collection. That's where the release notes are collected.
  • Call the UpdateViewHandler view wherever you need it.

Implementation

UpdateViewHandler(updateNotes: notes)

Screenshots

Demo 1

Simulator.Screen.Recording.-.iPhone.16.Plus.-.2024年10月10日.at.22.32.43.mp4

Demo 2

Simulator.Screen.Recording.-.iPhone.16.Pro.-.2024年10月10日.at.21.30.15.mp4

About

A simple and lightweight Swift library to better present release notes in iOS, iPadOS and visionOS apps

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

AltStyle によって変換されたページ (->オリジナル) /