8f964ea2cb
Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Grace Park <gracepark@github.com> Co-authored-by: Steve Guntrip <12534592+stevecat@users.noreply.github.com> Co-authored-by: Robert Sese <sese@github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com>
2.6 KiB
title, intro, redirect_from, versions, topics, shortTitle
| title | intro | redirect_from | versions | topics | shortTitle | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Creating a custom badge for your OAuth App | {% data reusables.shortdesc.creating_custom_badges_oauth_apps %} |
|
|
|
Create custom badges |
By default, a new OAuth App will have an automatically generated identicon. An identicon badge looks something like this:
After you create an OAuth App, you can customize the app's badge by uploading a logo and selecting a background color. A badge is a square logo image inside of a circular badge. You can choose a background color for the badge, which can be used to visually distinguish your app.
Your logo should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend an image size of at least 200px x 200px. {% ifversion fpt or ghec %}See "Tips for logo and badge images" for more guidance on customizing badges.{% endif %}
{% ifversion fpt or ghec %}
You can change a custom badge for a GitHub App that already has an approved Marketplace listing by navigating to https://github.com/marketplace/manage.
{% endif %}
To create a custom badge:
{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.developer_settings %} {% data reusables.user-settings.oauth_apps %} {% data reusables.user-settings.modify_oauth_app %}
- In "Application logo", drag-and-drop an image from a local folder or click Upload new logo to select an image from your computer.
- Crop your picture. When you're done, click Set new application logo.
- In "Badge background color", type the hexadecimal color code of the background color for your badge. {% ifversion fpt or ghec %}Note: The "Badge background color" input field will be visible after an application logo has been uploaded.{% endif %}
{% data reusables.user-settings.update_oauth_app %}
{% ifversion fpt or ghec %}
Next steps
For more information about creating a Marketplace listing for this app, see "Listing on GitHub Marketplace".
{% endif %}