/vercel-badge

Include a Vercel deployment badge in your project's README.md file.

Primary LanguageTypeScriptMIT LicenseMIT

Vercel Badge

Vercel License

Include a Vercel deployment badge in your project's README.md file. Visit the home page to generate a badge for your Vercel project.

Usage

For the application http://therealsujitk.vercel.app, the {VERCEL_APP_NAME} is therealsujitk.

HTML

<img src="https://therealsujitk-vercel-badge.vercel.app/?app={VERCEL_APP_NAME}" />

Markdown

![Vercel](https://therealsujitk-vercel-badge.vercel.app/?app={VERCEL_APP_NAME})

Other Parameters

  • ?style= - The style of the badge. Available styles: flat (Default), flat-square, plastic & for-the-badge.
  • ?root= - Use this paramater if you'd like to check the deployment of a different path. Example: To check the deployment of http://therealsujitk.vercel.app/projects/vercel-badge, specify root as projects/vercel-badge.
  • ?logo= - Use this paramater if you'd like to change the vercel logo on the badge. To learn more visit the Shields.io documentation.
  • ?name= - Use this parameter if you'd like to change the name of the badge.

To combine paramaters, use &. Example:

Vercel

http://therealsujitk-vercel-badge.vercel.app/?app=therealsujitk-vercel-badge&style=for-the-badge&logo=none

Links