From 30bed2d097d64fb2f33f044a54d3ccda572dd401 Mon Sep 17 00:00:00 2001 From: OMEGARAZER <869111+OMEGARAZER@users.noreply.github.com> Date: Tue, 11 Apr 2023 15:48:50 -0400 Subject: [PATCH 1/2] Add linting badge Adds a basic badge that can be used to show that Ruff is being used for linting. --- README.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/README.md b/README.md index 954abba3d10b78..884f1b8c0a7a81 100644 --- a/README.md +++ b/README.md @@ -389,6 +389,31 @@ 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) +### Want to show you're using Ruff too? + +You can use this badge in your project's README.md: + +```md +[![linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting)](https://github.com/charliermarsh/ruff) +``` + +or in your project's README.rst: + +```rst +.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting + :target: https://github.com/charliermarsh/ruff + :alt: Ruff +``` + +or as HTML: + +```html +Ruff +``` + +Which will look like this: +[![linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting)](https://github.com/charliermarsh/ruff) + ## License MIT From 39989a68733f1b8858d15bbbf085a93a79fa670d Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Fri, 12 May 2023 13:46:04 -0400 Subject: [PATCH 2/2] Tweak some of the copy --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 5d485a5ac2eafe..cc5e2b9d04fce2 100644 --- a/README.md +++ b/README.md @@ -397,31 +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) -### Want to show you're using Ruff too? +### Show Your Support -You can use this badge in your project's README.md: +If you're using Ruff, consider adding the Ruff badge to project's `README.md`: ```md -[![linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting)](https://github.com/charliermarsh/ruff) +[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff) ``` -or in your project's README.rst: +...or `README.rst`: ```rst -.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting +.. 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: +...or, as HTML: ```html -Ruff +Ruff ``` -Which will look like this: -[![linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v1.json&label=linting)](https://github.com/charliermarsh/ruff) - ## License MIT