search

getsentry / sentry-xamarin

Sentry for Xamarin Native and Xamarin.Forms
https://docs.sentry.io/platforms/dotnet/guides/xamarin/
44 stars 11 forks source link

Rollback: Update logo in readme #117

Closed lucas-zimerman closed 2 years ago

lucas-zimerman commented 2 years ago

As stated on https://github.com/getsentry/sentry-capacitor/pull/168

In https://github.com/getsentry/sentry-capacitor/pull/167, I updated the logo to use white or black based on theme. While this works well for GitHub, it was pointed out to me that we also render these readme files on package registries, and some (including NPM) do not set their theme correctly. (See https://github.com/getsentry/sentry-electron/pull/479#issuecomment-1118755203)

Updating to use the purple Sentry logo instead, which renders well on both white and black backgrounds, and will work for both GitHub and NPM.

Sorry for the friction.

skip-changelog

mattjohnsonpint commented 2 years ago

Thanks, but that doesn't apply to this repo at the moment.

Nuget is different. It doesn't render HTML whatsoever. For sentry-dotnet, I switched to plain markdown. But for this repo, we are not currently using the readme on nuget - we just show the package description.

So, either we keep it as currently is, which renders nicely only on GitHub, or we switch to the markdown version and configure PackageReadmeFile to render both on GitHub and Nuget.

mattjohnsonpint commented 2 years ago

Thinking this through, I think we should mirror what we do in sentry-dotnet. Otherwise, it makes the Sentry.Xamarin package look less official on Nuget. I'm closing this PR and will open a new one shortly. (Thanks though! 😄 )