Skip to content

Commit ff86a5e

Browse files
authored
Update README for improved clarity on cache-busting
Clarified the role of the 'nonce' query parameter in cache-busting.
1 parent 3850106 commit ff86a5e

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
### What is this?
66

7-
The cards on this page are [`github-readme-stats`](https://github.com/anuraghazra/github-readme-stats/) repo cards (adapted on a [fork](https://github.com/hesreallyhim/github-readme-stats-plus/) created and hosted by hesreallyhim in order to show more repo stats). They show the number of open Issues in this repo.
7+
The cards on this page are [`github-readme-stats`](https://github.com/anuraghazra/github-readme-stats/) repo cards (adapted on a [fork](https://github.com/hesreallyhim/github-readme-stats-plus/) created and hosted by [hesreallyhim](https://github.com/hesreallyhim) in order to show more repo stats). They show the number of open Issues in this repo.
88

99
### OK, so what?
1010

11-
Create a new Issue in this repo and observe whether the change is reflected immediately. GitHub uses a service called [camo](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls) for image caching and privacy/anonymization. That means that if you are serving an image with dynamic contentk changes to the content may not be reflected right away. This repo illustrates different approaches to cache-busting so you can see for yourself what works or does not work at the current point in time.
11+
GitHub uses a service called [camo](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/about-anonymized-urls) for image caching and privacy/anonymization. That means that if you are serving an image with dynamic content, changes to the content may not be reflected right away. This repo illustrates different approaches to cache-busting so you can see for yourself what works or does not work at the current point in time.
1212

1313
## 1. Baseline (no cache-busting techniques applied)
1414

@@ -26,7 +26,8 @@ Create a new Issue in this repo and observe whether the change is reflected imme
2626

2727
### Usage
2828

29-
The image URL below contains a query parameter `nonce` with a random number value. Create an Issue in this repository and write the word "nonce" somewhere in the body. This will trigger a GitHub Action that changes the query parameter value to some other "random" number. This is used to test whether changing query parameters is sufficient to bust the cache and refresh the image.
29+
> [!tip]
30+
> The image URL below contains a query parameter `nonce` with a random number value. Create an Issue in this repository and write the word "nonce" somewhere in the body. This will trigger a GitHub Action that changes the query parameter value to some other "random" number. This is used to test whether changing query parameters is sufficient to bust the cache and refresh the image content.
3031
3132
<div id="baseline">
3233
[![test-github-cache-bust](https://github-readme-stats-plus-theta.vercel.app/api/pin?username=hesreallyhim&repo=test-github-cache-bust&show_issues=true&nonce=123456)](https://github.com/hesreallyhim)

0 commit comments

Comments
 (0)