Badges & Shields
Adding badges and shields to your README.md
on GitHub allows you to display important and concise information.
Sketchpacks serves the following badges with up-to-date information from the Sketchpacks API.
To use these badges, be sure update the example markdown snippets with your information.
Sketch Compatibility Version
Display your plugin's Sketch compatibility version defined in your manifest.json
file.
[![Compatible Sketch Version](https://badges.sketchpacks.com/plugins/IDENTIFIER/compatibility.svg)](https://sketchpacks.com/GITHUB_HANDLE/GITHUB_REPO_NAME)
Latest Version badge
Display your plugin's latest version.
[![Download from Sketchpacks.com](https://badges.sketchpacks.com/plugins/IDENTIFIER/version.svg)](https://api.sketchpacks.com/v1/plugins/IDENTIFIER/download)
Total Downloads
Display all-time downloads count.
[![View on Sketchpacks.com](https://badges.sketchpacks.com/plugins/IDENTIFIER/downloads/total.svg)](https://sketchpacks.com/GITHUB_HANDLE/GITHUB_REPO_NAME)
Monthly Downloads
Display monthly downloads count.
[![View on Sketchpacks.com](https://badges.sketchpacks.com/plugins/IDENTIFIER/downloads/monthly.svg)](https://sketchpacks.com/GITHUB_HANDLE/GITHUB_REPO_NAME)
Weekly Downloads
Display weekly downloads count.
[![View on Sketchpacks.com](https://badges.sketchpacks.com/plugins/IDENTIFIER/downloads/weekly.svg)](https://sketchpacks.com/GITHUB_HANDLE/GITHUB_REPO_NAME)