# Badge and docs snippet

After it writes the two files, `vendor init` asks:

```text title="The question"
Add an "API changes delivered by Upseam" badge to README.md? [y/N]
```

## The badge

The badge is a static [shields.io](https://shields.io) badge that links to
`https://upseam.dev`.

```md title="README.md"
[![API changes delivered by Upseam](https://img.shields.io/badge/API%20changes%20delivered%20by-Upseam-2f6b46?labelColor=101010)](https://upseam.dev)
```

- It goes right after the first heading of `README.md`, or at the top when
  there is no heading. It is written with the other files, so you commit them
  together.
- Without a `README.md`, none is created and the command says so.
- A README that already links to `https://upseam.dev` is not changed.
- `--yes` adds the badge without asking and `--no-badge` skips it. Without a
  terminal the badge is added only with `--yes`. In a terminal, `--dry-run`
  shows the badge it would add and writes nothing.
- `--json` asks nothing and reports `badge` as `added`, `present`, `skipped`
  or `no-readme`. It also carries the snippet under `snippet`.

## The docs snippet

At the end, `vendor init` prints a section for your docs, under the heading
"Keep your integration up to date with Upseam".

```md title="Docs section"
## Keep your integration up to date with Upseam

When this API changes, Upseam finds the code in your repository that uses it and, after you approve, opens a pull request with the update. You review the pull request before anything is merged. To get these pull requests, install the [Upseam GitHub App](https://upseam.dev).
```

It is plain Markdown by default. `--snippet mdx` prints the same text in an
`mdx` block; it has a plain link and no components or raw HTML, so Mintlify
and Docusaurus accept it. Paste it where your docs list integrations. Upseam
does not edit your docs.