Crane is still in development, so this README represents a goal for 1.0. Send me a message if you have questions or suggestions for this project while it's spinning up.
I'm glad you asked! Crane is a lightweight installation framework for Mac applications. Developers build Crane into their applications, and it springs into action when the application is launched from a downloads folder or disk image.
If your application is installed today by adding it to the Applications folder, it's a perfect candidate for Crane.
Ah, good question. When your application launches, Crane detects if it's running from the installation disk image or common download folders and offers to install it.
When the user clicks Install, Crane copies your application to the computer's Applications folder, launches it, and optionally moves the installer to the trash.
You're right, the basic idea behind Crane is simple. But you should use it instead of writing your own installer for two reasons:
-
Most users haven't heard of Sparkle, but they've used it: is powers many popular Mac applications' software update functionality. As soon as a user sees the familiar update dialog in a new application, they know what to expect from the update process.
If a user has ever installed a Crane-enabled application before, they know what to expect when installing yours.
-
When you roll your own install helper, you may end up fixing the same bug that 20 other developers have worked on in theirs. When you use Crane, you get everyone's fixes and improvements for free.