diff --git a/python/quality/package_black/README.md b/python/quality/package_black/README.md index a2e048e5a8ca1dc1f10bf734759a19409d9d41c5..e6da0f9ce94cf2b95fb0bff0db9975730fb06f1d 100644 --- a/python/quality/package_black/README.md +++ b/python/quality/package_black/README.md @@ -1,10 +1,17 @@ ## Objective -Run [Black](https://github.com/psf/black) on your Python code to ensure it complies with the coding style -guide. +Run [Black](https://github.com/psf/black) on your Python code to ensure it complies with the coding +style guide. ## How to use it 1. Create a [python package](https://packaging.python.org/en/latest/tutorials/packaging-projects/). 2. Include template in your CI/CD conf (see quick use above) 3. Customize the template if it's relevant + +## Add <a href="https://github.com/psf/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a> cartouche to your project README.md +```markdown +<a href="https://github.com/psf/black"> + <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"> +</a> +``` \ No newline at end of file