87 Commits
Author SHA1 Message Date
Zorg 2244ef23df Add documentation for testing notarized production builds (#228)
This advises developers to use alternate feed with a forever-far-out stub build.

Proper testing of notarized builds is useful for testing code signing policies that may not otherwise be triggered.
2025-09-06 18:23:40 -07:00
Zorg b6896c8ff7 Update 2.7 (beta) -> 2.7 (#227) 2025-02-23 06:59:49 -08:00
Zorg 0cd6c4ed75 Update documentation for 2.7.0 beta (#226)
This includes SUVerifyUpdateBeforeExtraction, Apple Archives (along with archive types), and delta format version 4.
2024-12-26 10:16:46 -08:00
Zorg a0306d0f9c Simplify recommending re-using same archive as on website again (#225) 2024-07-04 13:03:06 -07:00
Zorg c31faabebf Clarify section for trimming Sparkle (#214)
Also re-write sentence for jumping to sandbox guide.
2024-02-25 16:07:52 -08:00
Zorg 0d36a43336 Clarify sandboxing setup with slightly stronger language (#213) 2024-02-24 18:27:40 -08:00
Kevin Wojniak b8502be2ad Fix typo (#210) 2023-11-29 20:47:03 -08:00
Zorg 13931567f2 Add additional space after manual setup instructions (#209) 2023-11-11 10:33:35 -08:00
Zorg 79d8068c2c Indent setup instructions for SPM and Carthage (#208) 2023-11-11 10:22:31 -08:00
Zorg 8d0ec762f9 Update recommendation on archives used (#206)
Relax language a bit for disk images and discourage package installations more prominently.
2023-10-30 21:24:33 -07:00
Zorg 6e1b859729 Clarify going up one enclosing folder to find SPM tools (#200) 2023-08-11 21:39:31 -07:00
Zorg ff9019ed0b Add documentation for initial 2.4 changes (#185) 2023-03-03 21:55:02 -08:00
Zorg 8120374fae Add Security and reliability page (#178) 2023-01-21 10:19:09 -08:00
Zorg bcb122527e Add clarification for not setting feed url and update checking (#176) 2022-12-02 22:23:36 -08:00
Zorg cfc9429fa3 Improve clarification on sandboxing documentation (#175)
Break the sandboxing page into components rather than XPC Services. XPC Services should no longer be emphasized for the Communication component because it is much more likely for apps to implement the entitlements rather than the XPC Services.
2022-10-08 12:07:23 -07:00
Zorg 7169798027 Revamp and improve SwiftUI programmatic samples (#168)
We provide a more sound SwiftUI sample and also show how to add user settings to a SwiftUI app.

Also rename Preferences to Settings in across the documentation.
2022-09-10 08:25:21 -07:00
Zorg 991c110a9b Update expectations on using updater APIs (#163) 2022-09-03 09:13:57 -07:00
Zorg 479cf970c0 Add programmatic setup for Qt and other non-Apple toolkits (#160) 2022-09-02 06:55:00 -07:00
Zorg 61264ee5a0 Document testing Sparkle's automatic and manual update checks (#157) 2022-08-26 21:52:53 -07:00
Kenneth Quintero 626b108721 Fix typo (#155) 2022-08-11 06:39:40 -07:00
Zorg b4ef4df453 Add note about keeping private keys safe (#153) 2022-07-02 17:13:35 -07:00
Zorg 789148feb5 Update documentation for 2.2 (#151) 2022-07-02 12:29:16 -07:00
Zorg 9b78fc1e78 Update documentation for 2.2 beta (#145) 2022-06-11 17:01:33 -07:00
Zorg a3b47dfdc2 Document hurdles around enabling library validation (#144) 2022-06-05 22:34:26 -07:00
Zorg e788ba371e Update documentation for Sparkle 2.1 beta (#127)
* Update delta documentation to include metadata specification.
* Update mentions of archives to encourage/suggest LZMA (.tar.xz)
* Note 2.1 beta publishing features for informational updates and major upgrades
2022-01-30 23:59:54 -08:00
Zorg 9af4a74e78 Update Xcode and nib instructions (#125) 2021-12-28 11:02:14 -08:00
Zorg 3260dcc399 Update SPM instructions (#124) 2021-12-28 10:50:29 -08:00
Zorg 8b2d8e7701 Update documentation for official Sparkle 2 release (#112) 2021-12-26 15:30:06 -08:00
Zorg 2564f54f40 Clarify what should be used instead of installer package (#120) 2021-12-18 11:55:51 -08:00
Zorg 37c02f340b Add clarification on signing, distribution, rotating keys (#118) 2021-12-18 10:09:38 -08:00
Zorg 92cd63c88c Refer users to generate_appcast help page (#115) 2021-12-12 16:50:47 -08:00
Zorg 01809c5022 Create separate section for key rotation (#111) 2021-12-11 21:27:24 -08:00
Zorg 10cc619286 Update package management details (#110)
Replace CocoaPods button on main webpage with link to Basic setup.

Clarify that Sparkle tools are not included in Carthage package.
2021-12-11 15:35:29 -08:00
Zorg 03191bb79e Copy Carthage binary distribution file (#109) 2021-12-11 11:26:14 -08:00
Zorg db57f5122a Add documentation clarification (#108)
Clarify the purpose of requiring CFBundleVersion.

Clarify in Testing that debugging issue shouldn't happen with workflow we suggest.

Clarify compression suggestions.
2021-12-05 22:55:48 -08:00
Zorg 4e2f37e456 Recommend zip and tarball formats more strongly (#107) 2021-11-26 16:28:02 -05:00
Zorg f6dfc9d580 Clarify alternative programmatic setup and other UI toolkits (#99) 2021-10-24 17:59:02 -07:00
Zorg 3c9b81ddc9 Update sandboxing documentation due to now bundling XPC Services (#93) 2021-10-23 21:23:46 -07:00
Zorg 3d12ae08ff Improve EdDSA migration documentation (#88)
Clarify Sparkle 2 needed for understanding EdDSA keys.

Sparkle 1.27 is now released.

Clarify importance of keeping keys safe and not losing them.
2021-09-17 20:21:49 -07:00
Mayur Pawashe 5b7555f096 Add API reference to sitemap and link to SUAppcastItem API spec (#86) 2021-09-06 15:42:49 -07:00
Mayur Pawashe 3d7d9ea09e Update setup guide for pre-releases and improve SPM docs (#85) 2021-09-06 11:30:09 -07:00
Mayur Pawashe d572ae98bb Integrate API Reference pages (#83) 2021-09-03 19:38:30 -07:00
Mayur Pawashe d80c1f8b8d Add minor documentation changes (#80)
* Fix programatic/programmatic typo
* Refer to programmatic setup in upgrading section instead of recommending SPUUpdater
* Update sparkle-cli usage
* Update .gitignore to ignore Jekyll cache files
2021-08-21 11:55:20 -07:00
Zorg 2c46c7b0e5 Fix generate_appcast invocation
Due to indentation it was showing ```sh on the page.
2021-08-15 16:01:35 -07:00
Zev Eisenberg de9b694321 Add syntax highlighting to code snippets. (#77) 2021-08-15 15:27:20 -07:00
Mayur Pawashe 25f4f51976 Document and show example of starting Sparkle programmatically (#75) 2021-07-19 08:02:45 -07:00
Mayur Pawashe d8ba222860 Update documentation for several recent features (#74)
* EdDSA migration from DSA
* No EdDSA deprecation
* Channels
* Setting feed programmatically
* Migrating to newer features using new appcast (linked from EdDSA migration)
* Extending the Appcast with custom extensions
* Migration notes from earlier versions of Sparkle 2
* Minor rewording on some pages
2021-07-18 14:38:02 -07:00
Mayur Pawashe be8623940e Add documentation for missing features (#73)
* Swift Package Manager
* Informational updates (2.x)
* Critical updates
* Phased Group Rollouts
* sparkle:maximumSystemVersion

Added migration notes for:
* not allowing downgrades
* SPARKLE_BUILD_UI_BITS instead of SparkleCore

Added note for previous sparkle:version recommendation.

Minor additional changes (adding Publishing an update link to bottom of docs page, improving CFBundleVersion link to official source).
2021-07-04 08:54:07 -07:00
Mayur Pawashe 87277e1e0c Update instructions documentation on sandboxing / XPC Services (#67)
* Update instructions documentation on sandboxing / XPC Services

* Remove required/optional annotations
2021-04-05 19:10:04 -07:00
Mayur Pawashe 35dd50cf3a Docs update 2x (#66)
* Update Sparkle 2.x paths, migration notes, code signing XPC Services

* Rename 1.x and 2.x to 1 and 2 where appropriate

* Update app cast example to use edSignature and remove Test App zip

* Update copyright to include initial release year
2021-03-08 21:06:07 -08:00