Skip to content

Commit

Permalink
Add warning about URL encoding in GitHub
Browse files Browse the repository at this point in the history
  • Loading branch information
AitorAstorga committed Feb 7, 2025
1 parent b1100dc commit f77592c
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,9 @@
</a>

<h1 align="center">Visit Counter API</h1>
<p align="center">
<img
src="https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME/svg?label=Visits" height=20
alt="Visit Counter" />
</p>
<p align="center"> <img
src="https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME/svg?label=Example%20Visits" height=20
alt="Visit Counter" /> </p>

<p align="center">
A self‑hostable API service in Rust for tracking website visits and generating customizable SVG counters.
Expand Down Expand Up @@ -77,6 +75,9 @@ If you simply want to utilize my API, you can simply add an `img` tag to your si
- `label`: The text shown to the left.
- `style`: Directly embed CSS in here. Something like `":root { --background-counter: red; }"` would work.

> [!TIP]
> If you intend to use this in GitHub, make sure you encode all spaces with `%20`. [HTML URL Encoding Reference](https://www.w3schools.com/tags//ref_urlencode.asp)
#### Customizing the SVG Appearance

The style is controlled with the CSS variables defined `assets/style.css`. These constants can also be modified to adjust the appearance:
Expand Down

0 comments on commit f77592c

Please sign in to comment.