More documentation updates preparing 3.0 release

This commit is contained in:
Andreas Linde 2013-02-10 18:15:34 +01:00
parent 3d812bb8b3
commit b490ae6144
5 changed files with 54 additions and 7 deletions

View File

@ -48,7 +48,7 @@
3. Configure each module.
4. Start up all modules.
The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on startup can also be catched and each module executes other code with a delay some seconds. This ensures that applicationDidFinishLaunching will process as fast as possible and the SDK will not block the startup sequence resulting in a possible kill by the watchdog process.
The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on startup can also be caught and each module executes other code with a delay some seconds. This ensures that applicationDidFinishLaunching will process as fast as possible and the SDK will not block the startup sequence resulting in a possible kill by the watchdog process.
All modules do **NOT** show any user interface if the module is not activated or not integrated.
`BITCrashManager`: Shows an alert on startup asking the user if he/she agrees on sending the crash report, if `[BITCrashManager crashManagerStatus]` is set to `BITCrashManagerStatusAlwaysAsk` (default)

View File

@ -1,6 +1,6 @@
## Version 3.0.0 RC1
## Version 3.0.0
- [Changelog](http://www.hockeyapp.net/help/sdk/ios/3.0.0RC1/docs/docs/Changelog.html)
- [Changelog](http://www.hockeyapp.net/help/sdk/ios/3.0.0/docs/docs/Changelog.html)
## Introduction
@ -26,9 +26,9 @@ The main SDK class is `BITHockeyManager`. It initializes all modules and provide
## Installation & Setup
- [Installation & Setup](http://www.hockeyapp.net/help/sdk/ios/3.0.0RC1/docs/docs/Guide-Installation-Setup.html) (Recommended)
- [Installation & Setup Advanced](http://www.hockeyapp.net/help/sdk/ios/3.0.0RC1/docs/docs/Guide-Installation-Setup-Advanced.html) (Using Git submodule and Xcode sub-project)
- [Migration from HockeyKit & QuincyKit](http://www.hockeyapp.net/help/sdk/ios/3.0.0RC1/docs/docs/Guide-Migration-Kits.html)
- [Installation & Setup](http://www.hockeyapp.net/help/sdk/ios/3.0.0/docs/docs/Guide-Installation-Setup.html) (Recommended)
- [Installation & Setup Advanced](http://www.hockeyapp.net/help/sdk/ios/3.0.0/docs/docs/Guide-Installation-Setup-Advanced.html) (Using Git submodule and Xcode sub-project)
- [Migration from HockeyKit & QuincyKit](http://www.hockeyapp.net/help/sdk/ios/3.0.0/docs/docs/Guide-Migration-Kits.html)
- [Mac Desktop Uploader](http://support.hockeyapp.net/kb/how-tos/how-to-upload-to-hockeyapp-on-a-mac)
@ -42,4 +42,4 @@ This documentation provides integrated help in Xcode for all public APIs and a s
3. Copy the content into ~`/Library/Developer/Shared/Documentation/DocSet`
The documentation is also available via the following URL: [http://hockeyapp.net/help/sdk/ios/3.0.0RC1/](http://hockeyapp.net/help/sdk/ios/3.0.0RC1/)
The documentation is also available via the following URL: [http://hockeyapp.net/help/sdk/ios/3.0.0/](http://hockeyapp.net/help/sdk/ios/3.0.0/)

View File

@ -1,3 +1,45 @@
### Version 3.0.0
- General:
- [NEW] Added new Feedback module
- [NEW] Minimum iOS Deployment version is now iOS 5.0
- [NEW] Migrated to use ARC
- [NEW] Added localizations provided by [Wordcrafts.de](http://wordcrafts.de):
Chinese, English, French, German, Italian, Japanese, Portuguese, Brazilian-Portuguese, Russian, Spanish
- [NEW] Added Romanian, Hungarian localization
- [UPDATE] Using embedded.framework for binary distribution containing everything needed in one package
- [UPDATE] Improved Xcode project setup to only use one static library
- [UPDATE] Providing build settings as `HockeySDK.xcconfig` file for easier setup
- [UPDATE] Remove `-ObjC` from `Other Linker Flags`, since the SDK doesn't need it
- [UPDATE] Documentation improvements
- [UPDATE] Exclude binary UUID check from simulator builds, so unit test targets will work. But functionality based on binary UUID cannot be tested in the simulator, e.g. update without changing build version.
- [BUGFIX] Fix some new compiler warnings
- [BUGFIX] Fix some missing new lines at EOF
- [BUGFIX] Make sure sure JSON serialization doesn't crash if the string is nil
- [BUGFIX] Various additional minor fixes
- Crash Reporting:
- [NEW] Add anonymous device ID to crash reports
- [UPDATE] The following delegates in `BITCrashManagerDelegate` moved to `BITHockeyManagerDelegate`:
- `- (NSString *)userNameForCrashManager:(BITCrashManager *)crashManager;` is now `- (NSString *)userNameForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager;`
- `- (NSString *)userEmailForCrashManager:(BITCrashManager *)crashManager;` is now `- (NSString *)userEmailForHockeyManager:(BITHockeyManager *)hockeyManager componentManager:(BITHockeyBaseManager *)componentManager;`
- [BUGFIX] Move calculation of time interval between startup and crash further up in the code, so delegates can use this information e.g. to add it into a log file
- [BUGFIX] Call delegate also if a crash was detected but could not be read (if handling crashes on startup is implemented)
- [BUGFIX] Format timestamp in crash report to be always UTC in en_US locale
- [BUGFIX] Make sure crash reports incident identifier and key don't have special [] chars and some value
- Feedback:
- [NEW] User feedback interface for direct communication with your users
- [NEW] iOS 6 UIActivity component for integrating feedback
- [NEW] Ask user details and show compose screen automatically on first opening feedback list view
- Updating:
- [NEW] Support for In-App updates without changing `CFBundleVersion`
- [UPDATE] Update UI modified to be more iOS 6 alike
- [UPDATE] Update UI shows the company name next to the app name if defined in the backend
- [BUGFIX] Fix a problem showing the update UI animated if there TTNavigator class is present even though not being used
### Version 3.0.0 RC 1
- General:

View File

@ -133,6 +133,8 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc
7. Replace `LIVE_IDENTIFIER` with the app identifier of your release app. We suggest to setup different apps on HockeyApp for your test and production builds. You usually will have way more test versions, but your production version usually has way more crash reports. This helps to keep data separated, getting a better overview and less trouble setting the right app versions downloadable for your beta users.
*Note:* The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on startup can also be caught and each module executes other code with a delay some seconds. This ensures that applicationDidFinishLaunching will process as fast as possible and the SDK will not block the startup sequence resulting in a possible kill by the watchdog process.
<a id="udid"></a>
## Submit the UDID

View File

@ -103,6 +103,9 @@ If you need support for iOS 3.x, please check out [HockeyKit](http://support.hoc
7. Replace `LIVE_IDENTIFIER` with the app identifier of your release app. We suggest to setup different apps on HockeyApp for your test and production builds. You usually will have way more test versions, but your production version usually has way more crash reports. This helps to keep data separated, getting a better overview and less trouble setting the right app versions downloadable for your beta users.
*Note:* The SDK is optimized to defer everything possible to a later time while making sure e.g. crashes on startup can also be caught and each module executes other code with a delay some seconds. This ensures that applicationDidFinishLaunching will process as fast as possible and the SDK will not block the startup sequence resulting in a possible kill by the watchdog process.
<a id="udid"></a>
## Submit the UDID