chore: Update README

[fardin01]

This commit updates the README to include the findings in #137, because it is useful to have this information directly in the README rather than having to search for it.

[fzipi]

LGTM. The next obvious step will be (in a followup PR) to add this example as part of the github action build process, so we can test everything works properly 😄

[fardin01]

LGTM. The next obvious step will be (in a followup PR) to add this example as part of the github action build process, so we can test everything works properly 😄

Great.

Do you mean adding it to e2e tests?

[fzipi]

🤔 It was more about checking that the example files are sane and won't break anything if used.
I was thinking on a simple GHA that starts a caddy server with the example files and we test the response using curl or similar to see if it contains the host, etc. But if that is about e2e, then could be.

[M4tteoP]

Note: tests are failing because of #165, this branch needs to be rebased once that PR is merged

[sonarcloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud