# Add a Deploy to FadeHost button to your README

> One badge in a README that opens the panel with the repository filled in: the Markdown to paste, what the link does for signed-in and new visitors, and the parameters it takes.

Source: https://fadehost.com/docs/deploy-button/

A **Deploy to FadeHost** button lets anyone host your bot or app from your README in one click. The link opens the panel's create dialog with your repository already filled in; a visitor without an account creates one on the way and lands in the same dialog once their email is verified.

![Deploy to FadeHost](https://fadehost.com/deploy-button.svg)

## Paste this

Markdown, for a web app, API or static site:

```markdown
[![Deploy to FadeHost](https://fadehost.com/deploy-button.svg)](https://laplace.fadehost.com/register?intent=app&repo=https://github.com/OWNER/REPO)
```

For a Discord, Telegram or WhatsApp bot, use `intent=bot` so the dialog opens on the Bots page:

```markdown
[![Deploy to FadeHost](https://fadehost.com/deploy-button.svg)](https://laplace.fadehost.com/register?intent=bot&repo=https://github.com/OWNER/REPO)
```

HTML, when the README is not Markdown:

```html
<a href="https://laplace.fadehost.com/register?intent=app&repo=https://github.com/OWNER/REPO"><img src="https://fadehost.com/deploy-button.svg" alt="Deploy to FadeHost" height="36"></a>
```

Replace `OWNER/REPO` with your repository. The repository has to be public, or the visitor adds a token for it in the dialog.

## What the visitor sees

- **Signed in:** the Apps or Bots page opens with the create dialog on the repository step, your URL in the field. They pick a name and a region, add the environment variables your README asks for, and press Create.
- **New:** the register page, then the verification mail, then the same dialog. The repository survives the whole way, on the same browser.
- **One of the FadeHost templates:** the dialog opens on that template's own form, with its fields, instead of the plain repository form.

## Parameters

| Parameter | Meaning |
| --- | --- |
| `intent=app` or `intent=bot` | Which page the dialog opens on; `app` for anything with a web address, `bot` for chat bots. |
| `repo=` | The GitHub URL, `https://github.com/OWNER/REPO`. Other hosts are ignored. |
| `name=` | Optional. A suggested name for the app, up to 40 characters. |

The same parameters work on the pages themselves for people who are already signed in: `https://laplace.fadehost.com/apps?repo=…` and `https://laplace.fadehost.com/bots?repo=…`.

## What the button does not do

It does not deploy anything by itself, set environment variables, or choose a tier. Say in the README which variables the app needs; the dialog has a box for them. The first bot or app on an account is free, so the visitor is never asked for a card.