diff --git a/README.md b/README.md index f2c7e0a3b0..dab506b6e6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -Introduction -============ +## Introduction HockeySDK-iOS implements support for using HockeyApp in your iOS applications. @@ -11,16 +10,27 @@ The following features are currently supported: The main SDK class is `BITHockeyManager`. It initializes all modules and provides access to them, so they can be further adjusted if required. Additionally all modules provide their own protocols. -Prerequisites -============= +## Prerequisites 1. Before you integrate HockeySDK into your own app, you should add the app to HockeyApp if you haven't already. Read [this how-to](http://support.hockeyapp.net/kb/how-tos/how-to-create-a-new-app) on how to do it. 2. We also assume that you already have a project in Xcode and that this project is opened in Xcode 4. 3. The SDK supports iOS 4.0 or newer. -Documentation -============= -Documentation can be build using [AppleDoc](https://github.com/tomaz/appledoc/) and the `Documentation` target. This will build the latest version and automatically install it in Xcode. +## Installation & Setup -The documentation contains installation and setup guides, various HowTos, quick troubleshooting and documentation of the public classes and protocols. +- [Installation & Setup](http://support.hockeyapp.net/kb/client-integration/hockeyapp-for-ios-hockeysdk) (Recommended) +- [Installation & Setup Advanced](http://support.hockeyapp.net/kb/client-integration/hockeyapp-for-ios-hockeysdk-advanced) (Using Git submodule and Xcode sub-project) +- [Migration from HockeyKit & QuincyKit](http://support.hockeyapp.net/kb/how-tos/how-to-migration-from-hockeykit-quincykit) +- [Mac Desktop Uploader](http://support.hockeyapp.net/kb/how-tos/how-to-upload-to-hockeyapp-on-a-mac) + + +## Xcode Documentation + +This documentation provides integrated help in Xcode for all public APIs and a set of additional tutorials and HowTos. + +1. Download the latest [HockeySDK-iOS documentation](https://github.com/bitstadium/HockeySDK-iOS/downloads). + +2. Unzip the file. A new folder `HockeySDK-iOS-documentation` is created. + +3. Copy the content into ~`/Library/Developer/Shared/Documentation/DocSet` diff --git a/docs/Changelog-template.md b/docs/Changelog-template.md index 8c85de9618..937e8744e1 100644 --- a/docs/Changelog-template.md +++ b/docs/Changelog-template.md @@ -1,36 +1,50 @@ ## Version 2.5 - General: + - [NEW] Unified SDK for accessing HockeyApp on iOS + - Requires iOS 4.0 or newer + - Replaces the previous separate SDKs for iOS: HockeyKit and QuincyKit. The previous SDKs are still available and are still working. But future HockeyApp features will only be integrated in this new unified SDK. + - Integration either as framework or Xcode subproject using the sourcecode Check out [Installation & Setup](Guide-Installation-Setup) + - [NEW] Cleaned up public interfaces and internal processing all across the SDK + - [NEW] [AppleDoc](http://gentlebytes.com/appledoc/) based documentation and HowTos This allows the documentation to be generated into HTML or DocSet. + - Crash Reporting: + - [NEW] Workflow to handle crashes that happen on startup. Check out [How to handle crashes on startup](HowTo-Handle-Crashes-On-Startup) for more details. - [NEW] Symbolicate iOS calls async-safe on the device - - [NEW] Single option to deactivate, require user to agree submitting and autosubmit + + - [NEW] Single property/option to deactivate, require user to agree submitting and autosubmit E.g. implement a settings screen with the three options and set `[BITCrashManager crashManagerStatus]` to the desired user value. + - [UPDATED] Updated [PLCrashReporter](https://code.google.com/p/plcrashreporter/) with updates and bugfixes (source available on [GitHub](https://github.com/bitstadium/PLCrashReporter)) + - [REMOVED] Feedback for Crash Groups Status Please keep using QuincyKit for now if you want this feature. This feature needs to be redesigned on SDK and server side to be more efficient and easier to use. + - Updating: + - [NEW] Expire beta versions with a given date + - [REMOVED] Settings screen If you want users to be able not to send analytics data, implement the diff --git a/docs/Guide-Installation-Setup-Advanced-template.md b/docs/Guide-Installation-Setup-Advanced-template.md index 5a57f373fa..a9655e8639 100644 --- a/docs/Guide-Installation-Setup-Advanced-template.md +++ b/docs/Guide-Installation-Setup-Advanced-template.md @@ -44,25 +44,17 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc 5. Select the tab `Build Phases`. -6. Expand `Target Dependencies`. +6. Expand `Link Binary With Libraries`. -7. Add the following dependencies: - * `HockeySDKLib` - * `HockeySDKResources` - - - -8. Expand `Link Binary With Libraries`. - -9. Add `libHockeySDK.a` +7. Add `libHockeySDK.a` -10. Drag & Drop `CrashReporter.framework` from the `Frameworks` folder in `HockeySDK.xcodeproj` +8. Drag & Drop `CrashReporter.framework` from the `Frameworks` folder in `HockeySDK.xcodeproj` -11. The following entries should be present: +9. The following entries should be present: * `CrashReporter.framework` * `libHockeySDK.a` * `CoreGraphics.framework` @@ -73,27 +65,27 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc -12. Expand `Copy Bundle Resources`. +10. Expand `Copy Bundle Resources`. -13. Drag & Drop `HockeySDKResources.bundle` from the `Products` folder in `HockeySDK.xcodeproj` +11. Drag & Drop `HockeySDKResources.bundle` from the `Products` folder in `HockeySDK.xcodeproj` -14. Select `Build Settings` +12. Select `Build Settings` -15. In `Header Search Paths`, add a path to `$(SRCROOT)\Vendor\HockeyKit\Classes` +13. In `Header Search Paths`, add a path to `$(SRCROOT)\Vendor\HockeyKit\Classes` -16. Search for `Other Linker Flags` +14. Search for `Other Linker Flags` -17. Double click on the build Setting titled Other Linker Flags. +15. Double click on the build Setting titled Other Linker Flags. -18. Add `-ObjC` +16. Add `-ObjC` -19. Hit `Done`. +17. Hit `Done`. -20. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries: +18. HockeySDK-iOS also needs a JSON library. If you deployment target iOS >= 5, everything is set. If your deployment target is iOS 4.x, please include one of the following libraries: * [JSONKit](https://github.com/johnezang/JSONKit) * [SBJSON](https://github.com/stig/json-framework) * [YAJL](https://github.com/gabriel/yajl-objc) diff --git a/docs/Guide-Installation-Setup-template.md b/docs/Guide-Installation-Setup-template.md index 5a7165cdef..e1c53eaa65 100644 --- a/docs/Guide-Installation-Setup-template.md +++ b/docs/Guide-Installation-Setup-template.md @@ -38,7 +38,7 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc 3. Select `Create groups for any added folders` and set the checkmark for your target. Then click `Finish`. - ![XcodeCreateGroups_normal.png](XcodeCreateGroups_normal.png) + 4. Select your project in the `Project Navigator` (⌘+1). @@ -55,9 +55,9 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc * HockeySDK.framework * QuartzCore.framework * SystemConfiguration.framework - * UIKit.framework + * UIKit.framework - ![XcodeFrameworks1.png](XcodeFrameworks1_normal.png) + 9. If one of the frameworks is missing, then click the + button, search the framework and confirm with the `Add` button. @@ -68,7 +68,7 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc 12. The following entries should be present: * `HockeySDKResources.bundle` - ![XcodeCopyBundle1.png](XcodeCopyBundle1_normal.png) + 13. Select `Build Settings` @@ -78,7 +78,7 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc 16. Add `-ObjC` - ![XcodeOtherLinkerFlags_normal.png](XcodeOtherLinkerFlags_normal.png) + 17. HockeySDK-iOS needs a JSON library if your deployment target is iOS 4.x. Please include one of the following libraries: * [JSONKit](https://github.com/johnezang/JSONKit) @@ -93,7 +93,7 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc 2. Add the following line at the top of the file below your own #import statements: - #import "HockeySDK.h" + #import 3. Let the AppDelegate implement the protocols `BITHockeyManagerDelegate`, `BITUpdateManagerDelegate` and `BITCrashManagerDelegate`: @@ -137,7 +137,7 @@ The method only returns the UDID when the build is not targeted to the App Sore. 4. Search for `preprocessor macros` - ![XcodeMacros1_normal.png](XcodeMacros1_normal.png) + 5. Select the top-most line and double-click the value field. @@ -145,7 +145,7 @@ The method only returns the UDID when the build is not targeted to the App Sore. 7. Enter the following string into the input field and finish with "Done".
CONFIGURATION_$(CONFIGURATION)
- ![XcodeMacros2_normal.png](XcodeMacros2_normal.png) + Now you can use `#if defined (CONFIGURATION_AppStore)` statements in your code. If your configurations have different names, please adjust the above use of `CONFIGURATION_AppStore`. diff --git a/docs/Guide-Migration-Kits-template.md b/docs/Guide-Migration-Kits-template.md index 0061a43fa9..3b4cfbfd93 100644 --- a/docs/Guide-Migration-Kits-template.md +++ b/docs/Guide-Migration-Kits-template.md @@ -103,11 +103,3 @@ After you have finished the setup guide make sure everything works as expected a ## Advanced Migration If you used any optional API calls, for example adding a custom description to a crash report, migrating those would exceed the scope of this guide. Please have a look at the [API documentation](https://github.com/bitstadium/HockeySDK-iOS/downloads). - - - - - - - - diff --git a/docs/XcodeTargetDependencies_normal.png b/docs/XcodeTargetDependencies_normal.png deleted file mode 100644 index 9448ea647b..0000000000 Binary files a/docs/XcodeTargetDependencies_normal.png and /dev/null differ