README badges
Two badges you can add to a project's README to show readers that it runs, or is tested, under es-python, with copy-paste snippets for Markdown, HTML and shields.io.
Which badge fits
Pick the one that describes what your project actually does today.
Protected by es-python: your service runs under es-python where it is deployed, so es-python follows untrusted input to the queries, commands and file paths it reaches, and reports each flow or stops it, depending on your settings.
Tested with es-python: your test suite runs under es-python, for example in CI, so a flow your tests exercise is reported before the code ships.
A badge is a statement to your readers. If the project stops running under es-python, take the badge down with it.
Markdown
Paste one of these into README.md. Each badge links to a page on eyalsec.com, so a reader who wonders what it means can find out in one click.
[](https://eyalsec.com/)
[](https://eyalsec.com/docs/ci)
HTML
For a README written in HTML, a docs site or a project page:
<a href="https://eyalsec.com/"><img src="https://eyalsec.com/static/badges/protected-by-es-python.svg" alt="Protected by es-python" height="20"></a>
<a href="https://eyalsec.com/docs/ci"><img src="https://eyalsec.com/static/badges/tested-with-es-python.svg" alt="Tested with es-python" height="20"></a>
shields.io
If your README already uses shields.io badges, the same two badges are available as shields.io endpoint files, so they match the style of the badges next to them. Add &style=flat-square, &style=for-the-badge or any other shields.io option to the URL.
[](https://eyalsec.com/)
[](https://eyalsec.com/docs/ci)
The endpoint files themselves are at https://eyalsec.com/static/badges/protected-by-es-python.json and https://eyalsec.com/static/badges/tested-with-es-python.json.