diff --git a/documentation/publishing/index.md b/documentation/publishing/index.md index d76d4fa..31b44ce 100644 --- a/documentation/publishing/index.md +++ b/documentation/publishing/index.md @@ -290,6 +290,20 @@ One approach is just waiting until the majority of your users are running a rece A second approach is migrating to a new `SUFeedURL` in your new application's `Info.plist`. This ensures that the application versions using your newer appcast have access to newer features. +## Full release notes + +In Sparkle 2, the `` element may be used to specify the full release notes, or version history, link to your product. When the user checks for updates and no new updates are available, Sparkle may let the user open this link in their web browser. If this element is not specified, Sparkle will default to using the `` element instead, which may be version specific. + +```xml + + Version 2.0 (2 bugs fixed; 3 new features) + https://myproductwebsite.com + 2.0 + https://myproductwebsite.com/app/2.0.html + https://myproductwebsite.com/app/full-history/ + +``` + ## Embedded release notes Instead of linking external release notes using the `` element, you can also embed the release notes directly in the appcast item, inside a `` element. If you wrap it in ``, you can use unescaped HTML. diff --git a/documentation/upgrading/index.md b/documentation/upgrading/index.md index 51aeea6..ed79618 100644 --- a/documentation/upgrading/index.md +++ b/documentation/upgrading/index.md @@ -54,6 +54,8 @@ If you are migrating from earlier alpha versions of Sparkle 2, you may find that If you use package (pkg) based updates, please see [Package Updates](/documentation/package-updates) for migration notes. In particular, your appcast items may need to include an appropriate installation type to help Sparkle decide if authorization is needed before starting the installer. This is not needed for bare package updates. +Sparkle 2 lets users view your application's [full release notes](/documentation/publishing#Full-release-notes) when they check for updates and no new updates are available. + Sparkle 2 enhances support for [major upgrades](/documentation/publishing#Major-upgrades). See [Sparkle 2's APIs](/documentation/api-reference) for more information.