Skip to content

Commit

Permalink
Update README.md with note and warning
Browse files Browse the repository at this point in the history
  • Loading branch information
IgorKowalczyk committed Dec 7, 2023
1 parent b741999 commit 7cd6282
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,13 +73,13 @@ You can overwrite default `Views` text with your own label.

![](https://github-views.deno.dev/api/badge/example?label=Your+own+label&display=true&color=blue)

> [!NOTE]
> Replace whitespace with `+` character in multi-word labels.
```markdown
![Github Views](https://github-views.deno.dev/api/badge/YOUR-USERNAME?label=Your+own+label)
```

> [!NOTE]
> Replace whitespace with `+` character in multi-word labels.
## 📦 `JSON` format

You can get the number of views in `json` format. It can be useful if you want to use the number of views in your application.
Expand Down Expand Up @@ -122,7 +122,8 @@ https://github-views.deno.dev/api/json/YOUR-USERNAME
## 🖥️ Hosting with Vercel

Versions `>= v3` does not support Vercel hosting. If you want to host this project on Vercel, use versions
> [!WARNING]
> Versions `>= v3` does not support Vercel hosting. If you want to host this project on Vercel, use versions
`<= v2`. To do this, go to [v2 branch](https://github.com/IgorKowalczyk/github-views/tree/v2.2.1) and follow the instructions corresponding to the version.

## ⁉️ Issues
Expand Down

0 comments on commit 7cd6282

Please sign in to comment.