From 68d664f13b2a1afd2a1e58b07db8174b5295980e Mon Sep 17 00:00:00 2001 From: Zorg Date: Mon, 15 Sep 2025 22:24:43 -0700 Subject: [PATCH] Restore API_README.markdown --- Documentation/API_README.markdown | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 Documentation/API_README.markdown diff --git a/Documentation/API_README.markdown b/Documentation/API_README.markdown new file mode 100644 index 00000000..af483d2d --- /dev/null +++ b/Documentation/API_README.markdown @@ -0,0 +1,12 @@ +# Sparkle 2 API Reference + +These are the primary classes and protocols in Sparkle 2 you may be interested in: + +- `SPUStandardUpdaterController` for creating a standard updater (encapsulates a `SPUUpdater` and `SPUStandardUserDriver`) +- `SPUUpdater` for invoking update checks and retrieving updater properties. +- `SPUUpdaterDelegate` for delegation methods to control the behavior of `SPUUpdater`. +- `SPUUserDriver` for making custom user interfaces. + +If you are migrating from Sparkle 1, please refer to `SPUStandardUpdaterController` and `SPUUpdater`. + +Please also visit the [Basic Setup](https://sparkle-project.org/documentation/) guide which shows how to instantiate an updater in a nib or how to create one programmatically.