README.md in motion-sparkle-0.0.3 vs README.md in motion-sparkle-0.0.4

- old
+ new

@@ -28,48 +28,66 @@ - [Contributing](#contributing) - [Credits](#credits) ## Overview -[Sparkle](http://sparkle.andymatuschak.org/) powers countless Mac applications' "Check for updates" feature. In a nutshell, when users click "Check for updates..." in an app, Sparkle checks for updates against an XML file that you post somewhere on the web. That XML file contains information about your new release, such as the version number, the URL of the package and its digital signature. If there's a newer version available than the one that is currently running, it'll ask for permission to retrieve the package and replace the current app with the new release. +[Sparkle](http://sparkle.andymatuschak.org/) powers the "Check for updates" feature of countless Mac applications. -While it's easy to use Sparkle with RubyMotion without motion-sparkle, it's even easier if you use it. The gem takes care of the Sparkle framework integration, simplifies its configuration and then automates the preparation of a release, creating a ZIP file, XML and release notes for you. +In a nutshell, when users click "Check for updates..." in an app, Sparkle checks for available updates against an XML file that you post somewhere on the web. That XML file contains information about your new release, such as the version number, the URL of the package and its digital signature. If there's a newer version available than the one that is currently running, it'll ask for permission to retrieve the package and replace the current app with the new release. -After building your app for release and running `rake sparkle:package`, all you need to do is upload 3 files to an URL you specified in the Rakefile and your users will be able to get the new release. +While it's easy to use Sparkle with RubyMotion without `motion-sparkle`, it's even easier if you use it. The gem takes care of the Sparkle framework integration, simplifies its configuration and then automates the preparation of a release, creating the ZIP, XML and release notes HTML file for you. +After building your app for release and running `rake sparkle:package`, all you need to do is upload 3 files to the URL you specify in the `Rakefile` and your users will be able to get the new release. + ## Installation In your project's Gemfile, add: +```ruby +# Gemfile - gem 'motion-sparkle' +gem 'motion-sparkle' +``` +and then run -and then run - $ bundle install ## Settings configuration -Configure Sparkle in your `Rakefile` using motion-sparkle's DSL: +Configure Sparkle in your `Rakefile` using `motion-sparkle`'s DSL: +```ruby +# Rakefile - # Rakefile - - app.sparkle do - # Required setting - release :base_url, 'http://example.com/releases/current' # `current` is a folder, don't use a trailing slash +app.sparkle do + # Required setting + release :base_url, 'http://example.com/releases/current' # `current` is a folder, don't use a trailing slash - # Recommended setting - # This will set both your `app.version` and `app.short_version` to the same value - # It's fine not to use it, just remember to set both as Sparkle needs them - release :version, '1.0' + # Recommended setting + # This will set both your `app.version` and `app.short_version` to the same value + # It's fine not to use it, just remember to set both as Sparkle needs them + release :version, '1.0' + + ## Optional settings and their default values and/or examples + + ## Please note that `base_url` must always be set (at the moment), + ## even you override it completely with the options below + + # Public Key + release :public_key, 'dsa_pub.pem' # default + + # Appcast Feed + release :feed_base_url, 'http://downloads.example.com/releases' # defaults to base_url + release :feed_filename, 'releases.xml' # default + + # Release Notes + release :notes_base_url, 'http://downloads.example.com/releases' # defaults to base_url + release :notes_filename, 'release_notes.html' # default - # Optional settings and their default values - release :feed_filename, 'releases.xml' - release :notes_filename, 'release_notes.html' - release :package_filename, "#{app.name}.zip" - release :public_key, 'dsa_pub.pem' - - end + # App Package + release :package_base_url, 'http://downloads.example.com/releases' # defaults to base_url + release :package_filename, "#{app.name}.zip" # default +end +``` To complete the configuration, run $ rake sparkle:setup @@ -96,53 +114,54 @@ ./resources/dsa_pub.pem # public certificate ./sparkle/config/dsa_priv.pem # private certificate -### Notes about the public certificate +### Notes about the public certificate The public certificate is placed at the root of the default `resources/` folder by default, as it needs to bundled with your app. If you chose to rename it, remember to set its correct value in the `Rakefile`, using `release :public_key, 'new_name.pem'`. -### Notes about the private certificate +### Notes about the private certificate The private certificate cannot be renamed nor placed elsewhere. If you have an existing certificate, please name it `dsa_priv.pem` and place inside the `sparkle/config/` folder ### Warning regarding your private certificate Be careful when handling the private certificate: you should never lose it nor share it. If you do, you'd lose the ability to sign your packages and users wouldn't be able to update your app. If someone takes it, they could sign the packages in your name and have your users install who knows what. -Tips: -* add it go your `.gitignore` or equivalent +Tips: +* add it go your `.gitignore` or equivalent * make a backup of it ### Run `rake sparkle:setup` at any moment to make sure your config is OK When all is good, move forward. If you need help, you can always open an issue on Github. ## Adding "Check for updates..." to the menu -Sparkle makes it incredibly easy to add a "Check for updates" feature to your app. +Sparkle makes it incredibly easy to add a "Check for updates" feature to your app. -Sparkle's `SUUpdater` class has a shared updater instance that can serve as a `target` for Sparkle actions. To launch the typical Sparkle flow, call the `checkForUpdates:` action. +Sparkle's `SUUpdater` class has a shared updater instance that can serve as a `target` for Sparkle actions. To launch the typical Sparkle flow, call the `checkForUpdates:` action. So, to launch the "Check for updates" flow, you can call `SUUpdater.new.checkForUpdates`. Here's an example based on the RubyMotion default OS X app example, "Hello". You can check out Sparkle's documentation for more details and further ways to customize the experience. This will add the classic "Check for updates..." entry on the menu; when the user clicks it, the nice default of experience of Sparkle will begin. In `menu.rb`, right below the line that adds the "Preferences" item: +```ruby + sparkle = addItemWithTitle("Check for updates...", action: nil, keyEquivalent: '') + sparkle.setTarget SUUpdater.new + sparkle.setAction 'checkForUpdates:' +``` - sparkle = addItemWithTitle("Check for updates...", action: nil, keyEquivalent: '') - sparkle.setTarget SUUpdater.new - sparkle.setAction 'checkForUpdates:' - Once you build your application, you should be able to see a "Check for updates..." item in the Application menu. Using it will work but will quickly produce an error. Keep going to make it work. ## First publication -Before you build, make sure you've set your `:base_url` to a destination where you can upload/download your files. +Before you build, make sure you've set your `:base_url` to a destination where you can upload/download your files. Note that packaging with motion-sparkle only works with the `:release` target at the moment, so make sure your build with be compatible with `rake build:release`. Run the setup command again to make sure it's all good: @@ -162,16 +181,18 @@ To do so, follow the same steps every time: ### 1. Bump the version - # In your Rakefile - - sparkle.app do - release :version, '1.1' # bump the versions - end +```ruby + # In your Rakefile + sparkle.app do + release :version, '1.1' # bump the versions + end +``` + ### 2. Build your app for release $ rake build:release ### 3. Update your Release Notes @@ -186,17 +207,17 @@ $ rake sparkle:package ### 5. Upload -Upload the 3 files and your new version is up. When users click "Check for updates...", the app should now display your release notes and ask the user to update. And when they do, the app will update and relaunch itself cleanly. +Upload the 3 files and your new version is up. When users click "Check for updates...", the app should now display your release notes and ask the user to update. And when they do, the app will update and relaunch itself cleanly. Sparkle for the win. ## Help, Limitations, Troubleshooting and Testing -If you need further help, please open an Issue on Github. +If you need further help, please open an [Issue on Github](https://github.com/webcracy/motion-sparkle/issues/). Limitations: * Only tested with Ruby 1.9.3-p448 * Only works with ZIP files @@ -209,11 +230,11 @@ Test coverage currently only extends to configuration and certificate generation checking. ## Contributing -Please do help with comments, issues and pull requests! +Please do help with comments, issues and pull requests! The gem's repository is at [github.com/webcracy/motion-sparkle](https://github.com/webcracy/motion-sparkle/). I've made a list of features that I look forward to having. You can attack those or suprise me :) Wanted features: @@ -227,15 +248,17 @@ Thanks! ## Credits +Contributors: [View all on Github](https://github.com/webcracy/motion-sparkle/graphs/contributors) + Author: Alexandre L. Solleiro -* Twitter - http://twitter.com/als * Github - http://github.com/webcracy +* Twitter - http://twitter.com/als * Website - http://webcracy.org Thanks to the authors and contributors of [HipByte/motion-cocoapods](https://github.com/HipByte/motion-cocoapods) and [drnic/choctop](https://github.com/drnic/choctop) gems, as I have looked for inspiration in their code. -And a low bow to [andymatuschak/Sparkle](https://github.com/andymatuschak/Sparkle)! +And a low bow to [andymatuschak/Sparkle](https://github.com/andymatuschak/Sparkle)!