Commit Graph

130 Commits

Author SHA1 Message Date
Zorg d7d5efe2fc Add documentation for full release notes (#105) 2021-11-08 00:33:44 -08:00
Zorg 3dd55c9397 Update documentation for re-signing Sparkle and its services manually (#102) 2021-11-08 00:33:25 -08:00
Zorg 7b96fb8b8a Document that web servers can customize the feed (#104) 2021-11-06 02:19:07 -07:00
Zorg 881a7abcae Add documentation for system profile privacy (#103) 2021-11-06 02:14:36 -07:00
Zorg 9eff77d9d9 Document headers and user agent string are present / customizable (#101) 2021-10-24 20:28:24 -07:00
Zorg 154671e648 Add info for Catalyst applications (#100) 2021-10-24 20:14:53 -07:00
Zorg f6dfc9d580 Clarify alternative programmatic setup and other UI toolkits (#99) 2021-10-24 17:59:02 -07:00
Zorg 6d1324d443 Fix typo 2021-10-24 17:39:59 -07:00
Zorg 3a80a9cc33 Warn about debugging XPC Services better (#98) 2021-10-24 17:38:51 -07:00
Zorg f2575a9c2f Add SwiftUI sample (#97) 2021-10-24 17:27:56 -07:00
Zorg 322defadd7 Elaborate on programmatic sample (#96) 2021-10-24 11:50:37 -07:00
Zorg 6fcdee5d55 Fix defect wording regarding Sparkle's downloader service + WKWebView (#95) 2021-10-24 11:19:45 -07:00
Zorg 492c59e271 Simplify programmatic example (#94) 2021-10-24 00:05:47 -07:00
Sparkle-Bot 3bcc323280 Update API reference documentation 2021-10-24 05:22:40 +00:00
Zorg 3c9b81ddc9 Update sandboxing documentation due to now bundling XPC Services (#93) 2021-10-23 21:23:46 -07:00
Zorg 8ddaa03e5b Recommend using bare package installations first (#92) 2021-09-25 22:03:53 -07:00
Sparkle-Bot b704a08244 Update API reference documentation 2021-09-20 16:24:22 -07:00
Zorg 2c3b7b3e09 Update API reference documentation 2021-09-19 16:42:27 -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
Ari 367f5210cc Fixed broken documentation link (#87) 2021-09-09 22:55:45 -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
Mayur Pawashe 50de28a827 Add CSS style tags for syntax highlighting (#79) 2021-08-15 16:38:04 -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
Zorg 0beb094753 Fix s/S(P)UUpdater/S(P)UUpdaterDelegate/ typo 2021-07-26 00:26:03 -07:00
Daniel Jalkut 10b73a0a79 Typo fiix 2021-07-21 19:29:59 +01: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
Zorg 467f26fd9f Fix sparkle:version value not enclosed by double quotes 2021-07-04 09:23:28 -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 6586b24aa7 Update documentation (part 1) (#72)
* Update documentation (part 1)

* Plug-in bundles & Sandboxing
* Javascript key
* sparkle:version element over attribute changes
* <link> additions (in case Sparkle uses them to fall back on, eg update not found)
* Major upgrades
* Minimum system requirement for 2.x
2021-06-28 19:59:36 -07:00
Mayur Pawashe 137c51b8dc Update XPC Service signing instructions to reflect latest changes (#68)
* Update XPC Service signing instructions to reflect latest changes

See https://github.com/sparkle-project/Sparkle/pull/1823

* Link to XPC Services section below and fix grammar error
2021-04-12 19:21:24 -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
Mayur Pawashe fb49b0eb1e Document support and migration path for non-archived pkg or mpkg updates (#65)
* Document support for non-archived pkg or mpkg updates

* De-emphasize support for bare packages

* Add more clarity
2021-02-27 12:57:26 -08:00
Mayur Pawashe f0c4edb027 Remove note that Sparkle 2 doesn't support minimumAutoupdateVersion (#63)
It now supports this on top of 2.x branch.
2021-01-24 11:36:32 -08:00
Zorg 616330c858 Remove legacy CocoaPods instructions 2021-01-10 15:07:17 +00:00
Zorg a2abe7245c Fix couple of typos 2021-01-10 15:07:17 +00:00
Zorg 0ee9312d86 Specify installation UI bits moved to Updater.app 2021-01-10 15:07:17 +00:00
Zorg c3680a0024 Specify release notes being reason we use webkit view 2021-01-10 15:07:17 +00:00
Zorg 1d84042c1b Make minor edits to sparkle-cli usage 2021-01-10 15:07:17 +00:00
Zorg 72b48212fa Add more links in migration setup 2021-01-10 15:07:17 +00:00
Zorg d8a8970d11 Note removing helpers in framework if using XPC Services is optional 2021-01-10 15:07:17 +00:00
Zorg a3acf637f3 Mention sandboxing in migration notes 2021-01-10 15:07:17 +00:00
Zorg 9feb4846aa Update Sandboxing notes
Leave out altering code sign script without hardened runtime which isn't accurate since Sparkle builds with hardened runtime automatically before the script invocation (which may not be needed).

Mention using custom XPC Service prefix.
2021-01-10 15:07:17 +00:00
Zorg d56a3a183e Update migration notes to 2.0
Add helper paths in InstallerLauncher XPC Service.

Add rationale for pkg update installation type.
2021-01-10 15:07:17 +00:00
Zorg 3d4e83c84f Recommend using Xcode's Archive Organizer for distribution 2021-01-10 15:07:17 +00:00