bugsplat-git / bugsplat-ios Goto Github PK

We're in a bind with our Unreal integration.

Currently, the user cannot set their BugSplat application name and version via our Unreal plugin, as doing so would require us to change the CFBundleExecutable. In the Unreal context, we provide a way to specify this value on all platforms except for iOS. It would be nice to keep these value in sync, without having the crash reporter change the CFBundleExecutable value.

Proposal: Can we set some other value in Info.plist, and use CFBundleExecutable as a fallback? We could also use a way to do this for CFBundleShortVersionString.

Update the readme to match the styles in the BugSplat Website ReadMe

![bugsplat-github-banner-basic-outline](https://user-images.githubusercontent.com/20464226/149019306-3186103c-5315-4dad-a499-4fd1df408475.png)
<br/><br/> 
# <div align="center">BugSplat</div> 
### **<div align="center">Crash and error reporting built for busy developers.</div>**
<div align="center"> <img alt="Twitter Follow" src="https://img.shields.io/twitter/follow/bugsplatco?label=Follow%20BugSplat&style=social">  <img alt="Discord" src="https://img.shields.io/discord/664965194799251487?label=Join%20Discord&logo=Discord&style=social"> </div>

There's a whole world of shields (badges) we can add next to the Twitter and Discord ones. Maybe add a last commit or project size shield from - https://shields.io/category/rating.

Follow these instructions for this repo to add social sharing image - https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/customizing-your-repositorys-social-media-preview

Social image for github.

Our Unity and Unreal engine integrations need this functionality.

On other platforms, we support both user credentials, as well as OAuth2 Client Credentials AKA database specific Client ID and Client Secret.

An example of how to upload symbols for a version using Client ID and Client Secret is available in the bugsplat-js-api-client repo.

OAuthClientCredentials API

• Login
• Fetch

Versions API

• PostSymbols

To make our repo's stand out a bit more, let's give them a spice of life with some emoji's in the chapter text.

Here's an example from our production website ReadMe

### :blue_book: Documentation
Our private repository and documentation is available at GitHub. Visit https://docs.bugsplat.com/ for further info.

You can find all of the emoji's github allows here - https://gist.github.com/rxaviers/7360908

Both the HockeyApp macOS and iOS SDKs use the same HockeyApp/iOS value for the User-Agent header. Our backend needs to determine which crashes are macOS and which are iOS so we can show the correct documentation link when a user is viewing a crash report in the web application.

Related to BugSplat-Git/BugSplat-macOS#21

For our samples we should handle symbol uploads as a Build Phase so that we can generate symbolicated crashes in development within the IDE. The Nineva team did this for our Unity sample and it works really well!