# Add a Deploy on blitz.cloud button to your README

> A button for your project's README that opens blitz.cloud with your repository filled in. Get the badge, the link and what happens after the click.

Web page: https://blitz.cloud/docs/deploy-button/
Updated: 2026-10-30

If you maintain a public project on GitHub, a "Deploy on blitz.cloud" button in its README gives people a way to try it without reading a setup guide first. A click opens blitz.cloud with your repository already filled in. Someone without an account signs up for free first and comes back to the same step. We build the project, using its Dockerfile if it has one and writing one if it does not, and put it online at its own address with HTTPS, in the EU.

## Get the snippet

```markdown
[![Deploy on blitz.cloud](https://blitz.cloud/badge/deploy.svg)](https://dashboard.blitz.cloud/new?repo=https://github.com/<owner>/<repo>)
```

Paste your repository's link above, then copy the Markdown for a README or the HTML, which switches to the dark badge when a reader's system is in dark mode.

## The link itself

```
https://dashboard.blitz.cloud/new?repo=https://github.com/<owner>/<repo>
```

The link only works for public GitHub repositories. A private repository, or a link to another host, shows a short note and the normal start of the flow instead.

## What happens after the click

1. Sign up, or sign in if you already have an account.
2. We look up the project.
3. Pick a name for the app.
4. We build it and put it online.

See [deploying a GitHub project](https://blitz.cloud/docs/deploy-from-github/) for how the build works, and [limits](https://blitz.cloud/docs/limits/) for what the free plan includes.