{"_id":"590a04f5ed80861900cbc76e","__v":0,"project":"55b2d5baa74a380d00e290c4","user":"55b2d5626862a10d00887af9","version":{"_id":"590a04f2ed80861900cbc737","project":"55b2d5baa74a380d00e290c4","__v":4,"createdAt":"2017-05-03T16:27:30.085Z","releaseDate":"2017-05-03T16:27:30.085Z","categories":["590a04f3ed80861900cbc738","590a04f3ed80861900cbc739","590a04f3ed80861900cbc73a","590a04f3ed80861900cbc73b","590a04f3ed80861900cbc73c","590a04f3ed80861900cbc73d","590a04f3ed80861900cbc73e","590a04f3ed80861900cbc73f","590a04f3ed80861900cbc740","590a04f3ed80861900cbc741","590a04f3ed80861900cbc742","590a04f3ed80861900cbc743","590a04f3ed80861900cbc744","590a04f3ed80861900cbc745","590a04f3ed80861900cbc746","590a04f3ed80861900cbc747","590a04f3ed80861900cbc748","590a04f3ed80861900cbc749","590a04f3ed80861900cbc74a","590a04f3ed80861900cbc74b","590a04f3ed80861900cbc74c","590a04f3ed80861900cbc74d","59124949de13f61900336a7a","5914b04e7c2c552d008b7104","5914b47242c6a22300b9dc20"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"7.0.0","version":"7"},"category":{"_id":"590a04f3ed80861900cbc73b","__v":0,"version":"590a04f2ed80861900cbc737","project":"55b2d5baa74a380d00e290c4","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-01-11T21:56:46.942Z","from_sync":false,"order":3,"slug":"ios-quickstart","title":"iOS Quickstart"},"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-10-02T19:39:24.953Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"# About the buddybuild SDK\nThe buddybuild SDK is a lightweight yet powerful suite of tools that integrates seamlessly into your application. The SDK includes a graphical feedback reporter, a crash reporting and analysis tool, automatic app updating and usage tracking. The SDK is regularly updated with new features.\n\nThe buddybuild SDK is available for both iOS and Android platforms and enables the following features:\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Integrating the buddybuild SDK will increase the size of the resulting \\\".ipa\\\" by less than 1 MB.\",\n  \"title\": \"File size of the buddybuild SDK\"\n}\n[/block]\n## Feedback Reporter\nWith buddybuild, you simply take a screenshot to share feedback. Our feedback reporter sends graphically annotated screenshots, feedback notes and device metadata to your team. Integrate with GitHub, JIRA and PivotalTracker to track feedback as issues. [Learn more.](doc:feedback-reporter)\n\n## Crash Analysis\nBuddybuild can notify you when your apps crashes. Get stack traces with lines of nearby source code and device metadata sent to your development team. [Learn more.](doc:crash-analysis)\n\n## Instant Replay\nNo more emailing testers for repro steps. Along with each crash report, buddybuild will also attach a 15 second video of your testers' interactions with your App's UI right up to the point where it crashed - allowing you to instantly see what they did to cause a crash.\n\n## Automatic Update\nReceiving feedback on old builds is pointless - you've probably already fixed the issue you've received feedback on! It is crucial to keep your testers and beta users updated on the very latest builds. If a newer build is available, the buddybuild SDK can automatically prompt to install the latest version of your app. [Learn more.](doc:automatic-update)\n\n## Usage Tracking\nKnow when your testers download and launch your app in real time. Identify who tested your app, when they launched it and what version they tested. Correlate this with feedback and crash reports to understand your customers' experience. [Learn more.](doc:usage-tracking)\n\n# How to install\nEnabling the SDK requires code changes in your iOS Application. We can make these changes automatically so you don't have to! Enable the buddybuild SDK in just two easy steps.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"App Store installs have all buddybuild SDK features **disabled** except for crash reporting.\\n\\nTestFlight builds deployed with buddybuild have all the buddybuild SDK features that were enabled. If you don't want your TestFlight deployments to have these features, you will have to turn them off in settings in the dashboard and submit a new build to TestFlight.\",\n  \"title\": \"SDK features for App Store and TestFlight Deployments\"\n}\n[/block]\n## Step 1: Configure SDK Installation\n\nOn your App's page, under the **Feedback** tab, click on the **Try the buddybuild SDK** button.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4e76c90-SDK_-_iOS_Install_Button.png\",\n        \"SDK - iOS Install Button.png\",\n        1500,\n        792,\n        \"#dcdcdf\"\n      ],\n      \"caption\": \"\",\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\n## Step 2: Install the SDK\n\nInstall the SDK in whatever branch you'd like. Typically, the SDK will be used by your testers, so you'll want to install the SDK on the branches that deploy to your testers.\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/85846e9-SDK_-_Turn_on_branch.png\",\n        \"SDK - Turn on branch.png\",\n        1500,\n        677,\n        \"#e6edee\"\n      ],\n      \"caption\": \"\",\n      \"sizing\": \"full\"\n    }\n  ]\n}\n[/block]\nThat's it! A new build will be kicked off with the SDK enabled. Install this build on your device. Open your app and take a screenshot - and see what happens!\n\nYou're all set now to deploy your app broadly to all your testers. There is just one more thing.\n\nTypically, development and testing devices need to be manually added to your provisioning profiles before they will accept deployed builds. This requires app developers to acquire the UDID (the device unique id) of the testing devices from the testers and then add them to the provisioning profiles used to build the app. This process is manual and is the source of a lot of headache for developers.\n\nWe've automated this process as well. Buddybuild can acquire UDIDs of your testers' devices, add them to your provisioning profiles completely automatically and transparently.\n\nTo enable this, connect your [Apple Developer account](doc:apple-developer-portal-sync) with buddybuild.\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Prefer to manually integrate the SDK?\",\n  \"body\": \"Follow the [Manual SDK Integration Guide](doc:sdk-integration).\"\n}\n[/block]\n## Update the SDK\n\n  * Open the Terminal and `cd` to your root directory of your repo.\n  * Run the following command `curl -Ls tools.buddybuild.com.s3-website-us-west-2.amazonaws.com/UpdateSDK | sh`\n  * Commit and push the changes.\n\n## Uninstall the SDK\n\nIf for some reason, you wish to uninstall the SDK, you simply need to revert the commit which installed it in the first place.","excerpt":"","slug":"integrate-sdk","type":"basic","title":"Integrating SDK"}
# About the buddybuild SDK The buddybuild SDK is a lightweight yet powerful suite of tools that integrates seamlessly into your application. The SDK includes a graphical feedback reporter, a crash reporting and analysis tool, automatic app updating and usage tracking. The SDK is regularly updated with new features. The buddybuild SDK is available for both iOS and Android platforms and enables the following features: [block:callout] { "type": "info", "body": "Integrating the buddybuild SDK will increase the size of the resulting \".ipa\" by less than 1 MB.", "title": "File size of the buddybuild SDK" } [/block] ## Feedback Reporter With buddybuild, you simply take a screenshot to share feedback. Our feedback reporter sends graphically annotated screenshots, feedback notes and device metadata to your team. Integrate with GitHub, JIRA and PivotalTracker to track feedback as issues. [Learn more.](doc:feedback-reporter) ## Crash Analysis Buddybuild can notify you when your apps crashes. Get stack traces with lines of nearby source code and device metadata sent to your development team. [Learn more.](doc:crash-analysis) ## Instant Replay No more emailing testers for repro steps. Along with each crash report, buddybuild will also attach a 15 second video of your testers' interactions with your App's UI right up to the point where it crashed - allowing you to instantly see what they did to cause a crash. ## Automatic Update Receiving feedback on old builds is pointless - you've probably already fixed the issue you've received feedback on! It is crucial to keep your testers and beta users updated on the very latest builds. If a newer build is available, the buddybuild SDK can automatically prompt to install the latest version of your app. [Learn more.](doc:automatic-update) ## Usage Tracking Know when your testers download and launch your app in real time. Identify who tested your app, when they launched it and what version they tested. Correlate this with feedback and crash reports to understand your customers' experience. [Learn more.](doc:usage-tracking) # How to install Enabling the SDK requires code changes in your iOS Application. We can make these changes automatically so you don't have to! Enable the buddybuild SDK in just two easy steps. [block:callout] { "type": "info", "body": "App Store installs have all buddybuild SDK features **disabled** except for crash reporting.\n\nTestFlight builds deployed with buddybuild have all the buddybuild SDK features that were enabled. If you don't want your TestFlight deployments to have these features, you will have to turn them off in settings in the dashboard and submit a new build to TestFlight.", "title": "SDK features for App Store and TestFlight Deployments" } [/block] ## Step 1: Configure SDK Installation On your App's page, under the **Feedback** tab, click on the **Try the buddybuild SDK** button. [block:image] { "images": [ { "image": [ "https://files.readme.io/4e76c90-SDK_-_iOS_Install_Button.png", "SDK - iOS Install Button.png", 1500, 792, "#dcdcdf" ], "caption": "", "sizing": "full" } ] } [/block] ## Step 2: Install the SDK Install the SDK in whatever branch you'd like. Typically, the SDK will be used by your testers, so you'll want to install the SDK on the branches that deploy to your testers. [block:image] { "images": [ { "image": [ "https://files.readme.io/85846e9-SDK_-_Turn_on_branch.png", "SDK - Turn on branch.png", 1500, 677, "#e6edee" ], "caption": "", "sizing": "full" } ] } [/block] That's it! A new build will be kicked off with the SDK enabled. Install this build on your device. Open your app and take a screenshot - and see what happens! You're all set now to deploy your app broadly to all your testers. There is just one more thing. Typically, development and testing devices need to be manually added to your provisioning profiles before they will accept deployed builds. This requires app developers to acquire the UDID (the device unique id) of the testing devices from the testers and then add them to the provisioning profiles used to build the app. This process is manual and is the source of a lot of headache for developers. We've automated this process as well. Buddybuild can acquire UDIDs of your testers' devices, add them to your provisioning profiles completely automatically and transparently. To enable this, connect your [Apple Developer account](doc:apple-developer-portal-sync) with buddybuild. [block:callout] { "type": "info", "title": "Prefer to manually integrate the SDK?", "body": "Follow the [Manual SDK Integration Guide](doc:sdk-integration)." } [/block] ## Update the SDK * Open the Terminal and `cd` to your root directory of your repo. * Run the following command `curl -Ls tools.buddybuild.com.s3-website-us-west-2.amazonaws.com/UpdateSDK | sh` * Commit and push the changes. ## Uninstall the SDK If for some reason, you wish to uninstall the SDK, you simply need to revert the commit which installed it in the first place.