From 1d165f7e9d35c761f7d969fac1b0e2f57defc4a8 Mon Sep 17 00:00:00 2001 From: OMEGA_RAZER <869111+OMEGARAZER@users.noreply.github.com> Date: Fri, 12 May 2023 13:58:29 -0400 Subject: [PATCH] Add linting badge that can be used to display usage (#3938) --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 0c0d259332..cc5e2b9d04 100644 --- a/README.md +++ b/README.md @@ -397,6 +397,28 @@ Ruff is used by a number of major open-source projects and companies, including: - [meson-python](https://github.com/mesonbuild/meson-python) - [nox](https://github.com/wntrblm/nox) +### Show Your Support + +If you're using Ruff, consider adding the Ruff badge to project's `README.md`: + +```md +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff) +``` + +...or `README.rst`: + +```rst +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json + :target: https://github.com/charliermarsh/ruff + :alt: Ruff +``` + +...or, as HTML: + +```html +Ruff +``` + ## License MIT